Skip to content

AGENTS.md

Latest commit

 

History

History
173 lines (123 loc) · 10.1 KB

AGENTS.md

File metadata and controls

173 lines (123 loc) · 10.1 KB

Development Rules

Conversational Style

  • Keep answers short and concise
  • No emojis in commits, issues, PR comments, or code
  • No fluff or cheerful filler text (e.g., "Thanks @user" not "Thanks so much @user!")
  • Technical prose only, be direct
  • When the user asks a question, answer it first before making edits or running implementation commands.
  • When responding to user feedback or an analysis, explicitly say whether you agree or disagree before saying what you changed.

Code Quality

  • Read files in full before wide-ranging changes, before editing files you have not fully inspected, and when asked to investigate or audit. Do not rely on search snippets for broad changes.
  • No any unless absolutely necessary.
  • Inline single-line helpers that have only one call site.
  • Check node_modules for external API types; don't guess.
  • No inline imports (await import(), import("pkg").Type, dynamic type imports). Top-level imports only.
  • Never remove or downgrade code to fix type errors from outdated deps; upgrade the dep instead.
  • Use only erasable TypeScript syntax (Node strip-only mode) in code checked by the root config (packages/*/src, packages/*/test, packages/coding-agent/examples): no parameter properties, enum, namespace/module, import =, export =, or other constructs needing JS emit. Use explicit fields with constructor assignments.
  • Always ask before removing functionality or code that appears intentional.
  • Do not preserve backward compatibility unless the user asks for it.
  • Never hardcode key checks (e.g. matchesKey(keyData, "ctrl+x")). Add defaults to DEFAULT_EDITOR_KEYBINDINGS or DEFAULT_APP_KEYBINDINGS so they stay configurable.
  • Never modify packages/ai/src/models.generated.ts directly; update packages/ai/scripts/generate-models.ts instead.

Commands

  • After code changes (not docs): npm run check (full output, no tail). Fix all errors, warnings, and infos before committing. Does not run tests.
  • Never run npm run build or npm test unless requested by the user.
  • Never run the full vitest suite directly: it includes e2e tests that activate when endpoint/auth env vars are present. For all non-e2e tests, run ./test.sh from the repo root. Otherwise run specific tests from the package root: node ../../node_modules/vitest/dist/cli.js --run test/specific.test.ts.
  • If you create or modify a test file, run it and iterate on test or implementation until it passes.
  • For packages/coding-agent/test/suite/, use test/suite/harness.ts + the faux provider. No real provider APIs, keys, or paid tokens.
  • Put issue-specific regressions under packages/coding-agent/test/suite/regressions/ named <issue-number>-<short-slug>.test.ts.
  • For ad-hoc scripts, write them to a temp file (e.g. /tmp), run, edit if needed, remove when done. Don't embed multi-line scripts in bash commands.
  • Never commit unless the user asks.

Dependency and Install Security

  • Treat npm dep and lockfile changes as reviewed code. Direct external deps stay pinned to exact versions.
  • Hydrate/update locally with npm install --ignore-scripts; clean/CI-style with npm ci --ignore-scripts. Don't run lifecycle scripts unless the user asks.
  • If dep metadata changes, refresh package-lock.json with npm install --package-lock-only --ignore-scripts.
  • If packages/coding-agent/npm-shrinkwrap.json needs regen, run node scripts/generate-coding-agent-shrinkwrap.mjs (verify with --check or npm run check). New deps with lifecycle scripts require review and an explicit allowlist entry in that script; never add one silently.
  • Pre-commit blocks lockfile commits unless PI_ALLOW_LOCKFILE_CHANGE=1. Don't bypass unless the user wants the lockfile change committed.

Git

Multiple pi sessions may be running in this cwd at the same time, each modifying different files. Git operations that touch unstaged, staged, or untracked files outside your own changes will stomp on other sessions' work. Follow these rules:

Committing:

  • Only commit files YOU changed in THIS session.
  • Stage explicit paths (git add <path1> <path2>); never git add -A / git add ..
  • Before committing, run git status and verify you are only staging your files.
  • packages/ai/src/models.generated.ts may always be included alongside your files.

Never run (destroys other agents' work or bypasses checks):

  • git reset --hard, git checkout ., git clean -fd, git stash, git add -A, git add ., git commit --no-verify.

If rebase conflicts occur:

  • Resolve conflicts only in files you modified.
  • If a conflict is in a file you did not modify, abort and ask the user.
  • Never force push.

Issues and PRs

See CONTRIBUTING.md for the contributor gate (auto-close workflows, lgtm/lgtmi, quality bar).

When creating issues:

  • Add pkg:* labels for affected packages (pkg:agent, pkg:ai, pkg:coding-agent, pkg:tui); use all that apply.

When posting issue/PR comments:

  • Write the comment to a temp file and post with gh issue/pr comment --body-file (never multi-line markdown via --body).
  • Keep comments concise, technical, in the user's tone.
  • End every AI-posted comment with the AI-generated disclaimer line specified by the originating prompt (e.g. This comment is AI-generated by /wr``).

When closing issues via commit:

  • Include fixes #<number> or closes #<number> in the message so merging auto-closes the issue. For multiple issues, repeat the keyword per issue (closes #1, closes #2); a shared keyword (closes #1, #2) only closes the first.

Testing pi Interactive Mode with tmux

Run the TUI in a controlled terminal (from the repo root):

tmux new-session -d -s pi-test -x 80 -y 24
tmux send-keys -t pi-test "./pi-test.sh" Enter
sleep 3 && tmux capture-pane -t pi-test -p     # capture after startup
tmux send-keys -t pi-test "your prompt here" Enter
tmux send-keys -t pi-test Escape               # special keys (also C-o for ctrl+o, etc.)
tmux kill-session -t pi-test

Changelog

Location: packages/*/CHANGELOG.md (one per package).

Sections under ## [Unreleased]: ### Breaking Changes (API changes requiring migration), ### Added, ### Changed, ### Fixed, ### Removed.

Rules:

  • All new entries go under ## [Unreleased]. Read the full section first and append to existing subsections; never duplicate them.
  • Released version sections (e.g. ## [0.12.2]) are immutable; never modify them.

Attribution:

  • Internal (from issues): Fixed foo bar ([#123](https://github.com/earendil-works/pi-mono/issues/123))
  • External contributions: Added feature X ([#456](https://github.com/earendil-works/pi-mono/pull/456) by [@username](https://github.com/username))

Releasing

Lockstep versioning: all packages share one version; every release updates all together. patch = fixes + additions, minor = breaking changes. No major releases.

  1. Update CHANGELOGs: ask the user whether they ran the /cl prompt on the latest commit on main. If not, they must run /cl first to audit and update each package's [Unreleased] section before releasing.

  2. Local smoke test: build an unpublished release and smoke test from outside the repo (so it can't resolve workspace files):

    npm run release:local -- --out /tmp/pi-local-release --force
cd /tmp

# Node package install smoke tests
/tmp/pi-local-release/node/pi --help
/tmp/pi-local-release/node/pi --version
/tmp/pi-local-release/node/pi --list-models
/tmp/pi-local-release/node/pi -p "Say exactly: ok"
/tmp/pi-local-release/node/pi

# Bun binary smoke tests
/tmp/pi-local-release/bun/pi --help
/tmp/pi-local-release/bun/pi --version
/tmp/pi-local-release/bun/pi --list-models
/tmp/pi-local-release/bun/pi -p "Say exactly: ok"
/tmp/pi-local-release/bun/pi

    Verify both Node and Bun startup, model/account listing, interactive startup, and at least one real prompt with the intended default provider. The bare commands /tmp/pi-local-release/node/pi and /tmp/pi-local-release/bun/pi start interactive mode; run each in tmux, submit a prompt, and wait for the model reply before considering the interactive smoke test passed. Failures are release blockers unless the user explicitly accepts the risk.

  3. Verify npm authentication: run npm whoami before starting the release script. If it fails, stop and tell the user to run npm login manually first, then retry after they confirm npm whoami succeeds.

  4. Brief the user on the WebAuthn flow before running anything. Print exactly the following message and then stop and wait for the user to confirm in their next message:

    Before the release publish step, read this carefully:

- `npm publish` uses WebAuthn 2FA.
- The safest flow is for you to run the publish command yourself, because you can see and open the npm authentication URL immediately.
- I will tell you the exact command to run.
- When npm prints an auth URL, cmd/ctrl-click it, log in in the browser, and select the "don't ask again for N minutes" option if available.
- This may happen more than once during publish.
- Do not rerun `npm run release:patch` or `npm run release:minor` after a failed publish; only rerun the publish command I give you.

Reply "ready" once you have read this and are ready to run the command locally.

    Do not proceed to step 5 until the user explicitly confirms.

  5. Run the release script:

    npm run release:patch    # fixes + additions
npm run release:minor    # breaking changes

    Do not pass a timeout to the bash tool for this call. If publish fails during the WebAuthn/OTP step after version bump, stop and tell the user to run npm run publish themselves from the repo root. Never rerun the version bump on your own. After the user reports publish success, continue with the post-publish steps.

  6. After publish succeeds:

    • Add fresh ## [Unreleased] sections to package changelogs.
    • Commit with Add [Unreleased] section for next cycle.
    • Push main and the release tag.

User Override

If the user's instructions conflict with any rule in this document, ask for explicit confirmation before overriding. Only then execute their instructions.