Setup
Install Pastoralist and keep your override appendix current
Install Pastoralist and keep your override appendix current
Add Pastoralist as a dev dependency:
npm install pastoralist --save-devOther package managers work too:
pnpm add pastoralist --save-devyarn add pastoralist --devbun add pastoralist --devFor a global CLI, install with npm or Homebrew:
npm install --global pastoralistbrew install yowainwright/tap/pastoralistCheck your dependency overrides without touching package.json:
npx pastoralist doctordoctor shows a summary of your dependency overrides.
The onboard command shows setup steps for local use, agents, and CI.
npx pastoralist onboardInstall the Pastoralist agent skill in a repo:
npx pastoralist --init agent-skillSet up local dev with selected skills and hooks:
pnpm run setup:local-dev -- --skills all --hooks git,postinstallRun the guided setup:
npx pastoralist initThe init command can detect workspaces, set up security checks, and save settings in a config file.
For a simple project, you can also run Pastoralist directly:
npx pastoralistPastoralist checks dependency overrides and updates its appendix; it does this without touching other package settings.
Most projects should run Pastoralist after dependency installs:
{ "scripts": { "postinstall": "pastoralist" }}Pastoralist can add that hook automatically:
npx pastoralist --setup-hookPreview the package.json update before writing anything:
npx pastoralist --dry-runPrint summary metrics for CI or release checks:
npx pastoralist --summaryRemove overrides that no package still depends on:
npx pastoralist --remove-unusedFor a workspace project with OSV security checks:
{ "pastoralist": { "depPaths": "workspace", "checkSecurity": true, "security": { "provider": "osv", "severityThreshold": "medium", "hasWorkspaceSecurityChecks": true } }}Read Configuration for all options or Workspaces & Monorepos for monorepo setup.
npm install pastoralist --save-devpnpm add pastoralist --save-dev
yarn add pastoralist --dev
bun add pastoralist --devnpm install --global pastoralist
brew install yowainwright/tap/pastoralistnpx pastoralist doctornpx pastoralist onboardnpx pastoralist --init agent-skillpnpm run setup:local-dev -- --skills all --hooks git,postinstallnpx pastoralist initnpx pastoralist{
"scripts": {
"postinstall": "pastoralist"
}
}npx pastoralist --setup-hooknpx pastoralist --dry-runnpx pastoralist --summarynpx pastoralist --remove-unused{
"pastoralist": {
"depPaths": "workspace",
"checkSecurity": true,
"security": {
"provider": "osv",
"severityThreshold": "medium",
"hasWorkspaceSecurityChecks": true
}
}
}