Onboarding

Follow these steps to add Pastoralist to a repo and share the setup with contributors and agents.

Start Read-Only

Check the current project without writing files:

npx pastoralist doctor

Add Project Setup

Install Pastoralist and create the initial config:

npm install pastoralist --save-dev
npx pastoralist init

Update the appendix once the config is in place:

npx pastoralist

Keep it current after dependency installs:

npx pastoralist --setup-hook

Add Agent Setup

Install the bundled Pastoralist skill:

npx pastoralist init agent-skill

The skill gives agents the commands and override tracking rules for this project. Review proposed config and override changes before applying them.

Add CI

Create .github/workflows/pastoralist.yml:

name: Override Checkon: [pull_request] jobs:  pastoralist:    runs-on: ubuntu-latest    steps:      - uses: actions/checkout@v7      - uses: yowainwright/pastoralist@v1        with:          mode: check          check-security: false

Verify

Use these commands before merging setup changes:

npx pastoralist --dry-runnpx pastoralist --dry-run --summarynpx pastoralist --dry-run --quiet --checkSecurity --strict