Skip to Content
Getting started

Getting started

Install

One line, with Node >= 18 and npm. No token is needed: pf and all its packages are public on the cellars registry.

npm install -g pulpfixer --registry https://cellars.staging.pangenea.com/ && pf setup

--registry applies to this install only, so your default npm registry is left alone. pf setup sets the machine up: shell completions, the optional registry auth line and cleanup of the legacy pulpfixer 1.x package (its data in ~/.pulpfixer is left alone). Add --yes (pf setup --yes) to accept every step without prompts, for example in a provisioning script.

An NPM_TOKEN (from the frontend team) is only needed to publish packages or to install private registry plugins.

From a checkout of the repo, the installer does the same and more:

scripts/install.sh # latest published version scripts/install.sh --from-source # build this checkout, pack its packages and install them globally scripts/install.sh --plugin jira # also install a registry plugin (repeatable) scripts/install.sh --dry-run # show what would happen

One global install brings everything: the pulpfixer package depends on @pulpfixer/kit and the built-in plugins.

First run

cd ~/code/my-service pf # the menu for this repo pf list # the same list, static (for scripts and agents) pf doctor # check the machine and repo

Inside a repo the menu starts with what pf found in it: the resolved dev, build, test and lint commands, the docs site, deploy targets and the repo’s own commands and tools. pf’s own entries (the agent, versions, plugins, …) follow. Shortcuts are not in the menu: pf s lists them. Outside a repo you get a fallback menu (run a skill, about, doctor).

Try a command without running it:

pf dev --dry-run pf docs --dry-run

Keep pf current

pf update --check # is there a newer version? pf update # pf, installed plugins, the ver and pnpm skills and registry skills pf uninstall # remove pf from this machine

pf update also refreshes a repo’s copies of the ver and pnpm helpers when you run it inside one. See Skills.

Set up a repo

Most repos need nothing. To give pf a few hints, or to add your own commands, write a pulpfixer.json:

pf init # writes pulpfixer.json from what was detected (--dry-run to preview) pf repo # hooks pf's pnpm commands and versioning into the repo

See pulpfixer.json and Tools and repo setup.

Last updated on