Connect a Postman API key to check your work
You do each step in Postman, then LiftOff uses your key to look at your workspace and confirm it's done. Connect once and it works for every module. Your key is saved in this browser and is only used to check your work in Postman.
Log In and Fork the Demo Repo
The Postman CLI does what the desktop app does from a shell, and it runs unchanged in CI. Everything you build here lives in your own public fork of a starter repo that already holds the Tasks API spec. The Postman Plugin module continues in the same fork. LiftOff reads it without a token, so it must stay public.
-
Install the Postman CLI. Pick one method:
npm (Windows, macOS and Linux):
npm install -g postman-clinpm install -g postman-clicurl (macOS, Linux and WSL):
curl -o- "https://dl-cli.pstmn.io/install/unix.sh" | shcurl -o- "https://dl-cli.pstmn.io/install/unix.sh" | shDon't mix both installers, because you can end up with two
postmanbinaries. More options are in the installation guide. -
Run the session below. It logs in with the API key you connected to LiftOff, checks who you are and forks the starter repo. The key is masked on this page, and copy puts the real command on your clipboard. Click a
$to tick off each command, or hit ▶ replay to see the expected output.# confirm the install workedpostman --versionpostman --version# log in with an API key: no browser steppostman login --with-api-key $POSTMAN_API_KEYpostman login --with-api-key $POSTMAN_API_KEYpostman whoamipostman whoamiLogged in to Postman as you@example.com# fork the starter repo (it stays public) and step into itgh repo fork Postman-Devrel/postman-terminal-demo --clone --default-branch-onlygh repo fork Postman-Devrel/postman-terminal-demo --clone --default-branch-onlycd postman-terminal-democd postman-terminal-demo# point gh at your fork, not the starter repo, for PRs and CI runs latergh repo set-default "$(gh api user --jq .login)/postman-terminal-demo"gh repo set-default "$(gh api user --jq .login)/postman-terminal-demo"lslsREADME.md openapi.yamlConnect your Postman API key in Settings first — then copy will fill it into this command.
Prefer a browser login? Run
postman loginwith no flags. You can also fork withoutgh: click Fork on github.com/Postman-Devrel/postman-terminal-demo, thengit cloneyour fork. Keep the repo namepostman-terminal-demoand keep it public. -
Set up a shortcut to save time. Every step from here ends by committing and pushing your work to GitHub, which is three git commands. This one-time line, run inside the repo, creates a
git savealias that does all three, so later steps need onlygit save "message":git config alias.save '!f() { git add -A && git commit -m "$1" && git push -u origin HEAD; }; f'git config alias.save '!f() { git add -A && git commit -m "$1" && git push -u origin HEAD; }; f'It only exists in this repo, so it won't affect your other projects.
-
Enter your GitHub username below, then click Validate. LiftOff checks that your Postman API key works and that your public fork exists on GitHub.
Troubleshooting: If you already have a postman-terminal-demo repo, for example from an earlier run of this module, rename or delete it before forking. Otherwise GitHub names the fork postman-terminal-demo-1 and LiftOff won't find it. GitHub also disables Actions on forks by default. You'll enable them in the Postman Plugin module when it adds CI.
Initialise Your Fork With `postman init`
postman init sets a repo up for API work. It creates the postman/ folders, a personal workspace bound to this repo, agent skills and an AGENTS.md file (both used later in the Postman Plugin module). Run it first, because collection new and environment new only work in an initialised repo.
-
Your fork already contains
openapi.yaml, the spec used for the rest of the module. It's intentionally rough, and you'll fix it in Step 3. Take a look withcat openapi.yamlor open it in your editor. It describes a small Tasks API: list tasks, create a task and get a task by ID. -
Preview, then run
init, then save.--dry-runwrites nothing and should pickopenapi.yamlas the spec,--yesaccepts the defaults and--visibility personalcreates your workspace:postman init --dry-runpostman init --dry-runpostman init --yes --visibility personalpostman init --yes --visibility personal# look at what it createdls -a . postmanls -a . postmangit save "Initialise Postman in the repo"git save "Initialise Postman in the repo"You should see
.postman/resources.yaml, thepostman/folders,postman/skills/, andAGENTS.md.
Troubleshooting:
Workspace step skipped: Missing tokenmeans you're not logged in. Runpostman whoami, log in again (Step 1), then re-runpostman init --yes --visibility personal.- Exit code
2: more than one spec could be the source. Add--spec openapi.yaml. - Exit code
5: the files were written but the workspace wasn't. Step 7 covers it. openapi.yamlis missing: you created an empty repo instead of forking. Fork Postman-Devrel/postman-terminal-demo (see Step 1).