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.
Check the Workspace Binding
postman init bound your repo to a workspace, and .postman/resources.yaml stores its ID. That file was already committed in Step 2, so anyone (or any agent) who clones the repo pushes to the same workspace. Before pushing, check the ID points at a real workspace that's yours.
-
Open the binding. You should see
workspace:with a non-emptyid::cat .postman/resources.yamlcat .postman/resources.yaml -
Only if the
id:is empty, create a workspace and commit the new binding. If an ID is already recorded this command refuses to run (unless you add--force), so skip this sub-step when you have one:postman workspace create --visibility personal --name "Postman Terminal Demo"postman workspace create --visibility personal --name "Postman Terminal Demo"git save "Bind repo to Postman workspace"git save "Bind repo to Postman workspace" -
Check the CLI can see the workspace.
workspace gettakes the ID as an argument, so read it from the binding first.workspace lintchecks everything before it leaves your machine:# read the id from the bindingWS_ID=$(awk '/^workspace:/{w=1} w && /id:/{print $2; exit}' .postman/resources.yaml)WS_ID=$(awk '/^workspace:/{w=1} w && /id:/{print $2; exit}' .postman/resources.yaml)postman workspace get "$WS_ID"postman workspace get "$WS_ID"postman workspace lintpostman workspace lintpostman workspace listshows every workspace on your account, which can be a long list. Narrow it with--filter "<name>"or--type personalif you want to browse.
Diff, Then Push to Your Workspace
Local files and the cloud workspace drift apart, so you'll repeat this loop for every change: diff, push, diff again. workspace diff shows what a push would change without touching anything, so it's a good habit before every push and a good CI gate.
-
Preview, push, then diff again. The second diff should show nothing, and
--exit-codeexits0when you're in sync:# read-only previewpostman workspace diffpostman workspace diff# push collections, specs and more to the bound workspacepostman workspace push --yespostman workspace push --yes# now in sync?postman workspace diff --exit-code; echo "exit code: $?"postman workspace diff --exit-code; echo "exit code: $?"
To go the other way, postman workspace pull brings changes made in Postman back into your local files.
Next up is the Postman Plugin module, which continues in this repo and drives the workflow with natural-language prompts.