Shortcuts
A shortcut is a short name for a full command. Extra arguments pass through to the target, so pf ds --dry-run is pf deploy staging --dry-run. That includes a commit message for the deploy shortcuts: pf d "fix login".
pf s (or pf shortcuts) lists them in the terminal, grouped by what they are for (Agent, Develop, Docs & deploy, …). Add a word to filter: pf s deploy. The menu and pf list do not repeat the list.
| Shortcut | Same as | Notes |
|---|---|---|
pf a | pf agent | Open the coding agent |
pf docs | pf doc | Run the repo’s docs site |
pf d | pf deploy | Staging if configured, else production, else the repo’s own deploy, else the publish |
pf ds | pf deploy staging | Auto-detects its target; the publish in a repo that only publishes |
pf dp | pf deploy production | Only a repo-defined production script (or the publish in a repo that only publishes); always confirms |
pf ps | pf publish staging | Runs publish:cellars (else the staging deploy); always confirms |
pf r | pf dev | Run the repo |
pf i | pf install | The repo’s install target (install:local first), else dependencies |
pf il, pf install-local | pf install local | Runs the repo’s install:local |
pf gp | pf git push | Push to the primary remote, then the backup remotes set up on this machine |
pf s | pf shortcuts | List the shortcuts, grouped |
pf rp | pf repo | Hook pf’s tools into this repo |
pf u | pf update | Update pf, plugins, suite extensions and skills |
pf v | pf ver | List versions and bump them |
pf vs | pf versions | List the versions of pf, plugins, skills and extensions installed here |
pf t | pf troubleshoot | Troubleshoot with the agent and AWS |
pf up | pf s3 | Upload to the exchange bucket |
Adding one
A shortcut is one entry in SHORTCUTS in packages/pulpfixer/src/commands/shortcuts.ts:
{ names: ['docs'], target: ['doc'], summary: 'Run the docs site locally (pf doc)', group: 'Docs & deploy' },group is one of the command groups; pf s shows the shortcut under it.
names can hold several short names for the same target, and target can have fixed arguments, such as ['deploy', 'staging']. Add a test in packages/pulpfixer/tests/shortcuts.test.ts.
Last updated on