Skip to Content
CommandsShortcuts

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.

ShortcutSame asNotes
pf apf agentOpen the coding agent
pf docspf docRun the repo’s docs site
pf dpf deployStaging if configured, else production, else the repo’s own deploy, else the publish
pf dspf deploy stagingAuto-detects its target; the publish in a repo that only publishes
pf dppf deploy productionOnly a repo-defined production script (or the publish in a repo that only publishes); always confirms
pf pspf publish stagingRuns publish:cellars (else the staging deploy); always confirms
pf rpf devRun the repo
pf ipf installThe repo’s install target (install:local first), else dependencies
pf il, pf install-localpf install localRuns the repo’s install:local
pf gppf git pushPush to the primary remote, then the backup remotes set up on this machine
pf spf shortcutsList the shortcuts, grouped
pf rppf repoHook pf’s tools into this repo
pf upf updateUpdate pf, plugins, suite extensions and skills
pf vpf verList versions and bump them
pf vspf versionsList the versions of pf, plugins, skills and extensions installed here
pf tpf troubleshootTroubleshoot with the agent and AWS
pf uppf s3Upload 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