Pi package for consistent AI coding workflows.
pi-codeflow is early and pre-release. Review the package source before installing it in real projects. It is not published to npm, does not claim production readiness, and does not automate merge or release authority.
Codeflow helps Pi Coding Agent follow a conservative repository lifecycle:
- inject workflow guidance before agent runs;
- prepare semantic branches with
/flow-start; - run project-configured checks with
/flow-check; - render and create commits from structured payloads with
/flow-commit; - render and open or update PRs from structured payloads with
/flow-pr; - read GitHub PR checks with
/flow-watch; - list and triage GitHub review threads read-only with
/flow-comments; - apply policy-gated review replies and resolutions with
/flow-fix-comments.
/flow-start
-> implement focused changes
-> /flow-check
-> /flow-commit
-> /flow-pr
-> /flow-watch
-> /flow-comments
-> fix valid review findings
-> /flow-check
-> /flow-commit
-> /flow-pr
-> /flow-watch
-> /flow-fix-comments
Human review and merge remain outside Codeflow.
Current recommended installation paths are GitHub and local clone installs:
pi install https://github.com/vnedyalk0v/pi-codeflowFor project-local setup when supported by Pi:
pi install -l https://github.com/vnedyalk0v/pi-codeflowSee Installation for pinned refs, temporary evaluation, local clone installs, requirements, and verification.
- Install pi-codeflow.
- Add
.pi/codeflow.jsonto the target project. - Start work with
/flow-start --type feat "Add Google OAuth login". - Make focused changes with the agent.
- Run
/flow-check. - Commit through
/flow-commit --payload .pi/codeflow/commit-payload.json. - Open a PR through
/flow-pr --payload .pi/codeflow/pr-payload.json. - Watch checks with
/flow-watch --required. - Triage review threads with
/flow-comments. - Use
/flow-fix-commentsonly after fixes and verification.
See Usage for the full end-to-end flow, command reference, and payload examples.
Project configuration lives at:
.pi/codeflow.json
See:
Codeflow is conservative by default:
- no normal work on reserved branches;
- no force-push or destructive git operations;
- no PR approval or merge automation;
- no package publishing or deployment;
- no review-thread resolution for
needs_human; - GitHub mutations only through explicit commands and policy gates.
See Security Model.
See Troubleshooting for missing packages, missing commands, invalid config, GitHub CLI authentication, failed checks, PR failures, and review-thread resolution blockers.
Install dependencies and run the package validation suite:
npm install
npm run checkIndividual checks:
npm run typecheck
npm test
npm run check:json
npm run check:text
npm run check:docsGitHub Actions runs the same package validation on PRs targeting dev or
main, and on pushes to dev or main.
- Early pre-release package.
- GitHub operations require GitHub CLI and authentication.
- Local checks execute commands from trusted project configuration.
- GitHub review-thread operations rely on GitHub GraphQL through
gh. /flow-fix-commentsreplies or resolves review threads; it does not edit code.- Branch protection, human review, merge approval, and release authority remain outside Codeflow.
- Self-review automation and final report command automation are future work.