Skip to content

docs: improve README #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Pi Monorepo

[Pi](https://github.com/earendil-works/pi) is a minimal terminal coding agent. It ships four tools, four execution modes, and a philosophy: adapt Pi to your workflows, not the other way around. Users extend it with TypeScript extensions, skills, prompt templates, and shareable packages.
Expand Down Expand Up @@ -44,7 +46,7 @@ mise trust && mise install

```bash
pnpm install # install dependencies
pnpm run check # lint + format + typecheck + test + validate (the full gate)
pnpm run check # lint + format:check + typecheck + test + validate (the full gate)
pnpm run test # vitest
pnpm run lint:fix # oxlint autofix
pnpm run sync:skills # copy canonical skills into packages/ before release
Expand Down