Your progress is only saved in this browser. to protect it and pick up on any device.

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.

0 of 2 steps0%
1

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.

  1. Install the Postman CLI. Pick one method:

    npm (Windows, macOS and Linux):

    zsh — ~
    npm install -g postman-clinpm install -g postman-cli
    0/1 run

    curl (macOS, Linux and WSL):

    zsh — ~
    curl -o- "https://dl-cli.pstmn.io/install/unix.sh" | shcurl -o- "https://dl-cli.pstmn.io/install/unix.sh" | sh
    0/1 run

    Don't mix both installers, because you can end up with two postman binaries. More options are in the installation guide.

  2. 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.

    zsh — ~
    # confirm the install worked
    postman --versionpostman --version
    # log in with an API key: no browser step
    postman login --with-api-key $POSTMAN_API_KEYpostman login --with-api-key $POSTMAN_API_KEY
    postman whoamipostman whoami
    Logged in to Postman as you@example.com
    # fork the starter repo (it stays public) and step into it
    gh repo fork Postman-Devrel/postman-terminal-demo --clone --default-branch-onlygh repo fork Postman-Devrel/postman-terminal-demo --clone --default-branch-only
    cd postman-terminal-democd postman-terminal-demo
    # point gh at your fork, not the starter repo, for PRs and CI runs later
    gh repo set-default "$(gh api user --jq .login)/postman-terminal-demo"gh repo set-default "$(gh api user --jq .login)/postman-terminal-demo"
    lsls
    README.md openapi.yaml
    0/7 runoutput shown is an example

    Connect your Postman API key in Settings first — then copy will fill it into this command.

    Prefer a browser login? Run postman login with no flags. You can also fork without gh: click Fork on github.com/Postman-Devrel/postman-terminal-demo, then git clone your fork. Keep the repo name postman-terminal-demo and keep it public.

  3. 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 save alias that does all three, so later steps need only git save "message":

    zsh — ~/postman-terminal-demo
    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'
    0/1 run

    It only exists in this repo, so it won't affect your other projects.

  4. Enter your GitHub username below, then click Validate. LiftOff checks that your Postman API key works and that your public fork exists on GitHub.

Note: The fork must be public. Forks of a public repo are public by default, and a private repo can't be read without a token.

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.

2

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.

  1. 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 with cat openapi.yaml or open it in your editor. It describes a small Tasks API: list tasks, create a task and get a task by ID.

  2. Preview, then run init, then save. --dry-run writes nothing and should pick openapi.yaml as the spec, --yes accepts the defaults and --visibility personal creates your workspace:

    zsh — ~/postman-terminal-demo
    postman init --dry-runpostman init --dry-run
    postman init --yes --visibility personalpostman init --yes --visibility personal
    # look at what it created
    ls -a . postmanls -a . postman
    git save "Initialise Postman in the repo"git save "Initialise Postman in the repo"
    0/4 run

    You should see .postman/resources.yaml, the postman/ folders, postman/skills/, and AGENTS.md.

Troubleshooting:

  • Workspace step skipped: Missing token means you're not logged in. Run postman whoami, log in again (Step 1), then re-run postman 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.yaml is missing: you created an empty repo instead of forking. Fork Postman-Devrel/postman-terminal-demo (see Step 1).