Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

extensions/the-system/README.md

Raw
Rendered preview
the-system

The System

The System gives a Pi project a lightweight place for its mission, plans, decisions, and implementation progress. Use it when work needs shared direction and visible human approval instead of an unstructured stream of prompts.

the-system demo: init, phase, spec, plan, human approval, exec with board update, doctor, all from /system

Start here

Run /system init MYPROJECT in the project you want to govern. Pi shows what it will create or update and asks for approval before changing files. Restart Pi to load the new project's guidance. Then run /system phase to establish the current working phase, or /system research <question> to begin exploring a problem.

/system research How should we support offline imports?

Each lifecycle command starts a new Pi turn with your instructions and current project status. Run /system spec <goal> to define what must be true. Run /system plan <work> to prepare a plan, then review and explicitly approve it. Run /system exec <work> to carry out approved work. Stages do not automatically advance, so you choose each next step. Enable Pi's codemode or tool_search when using lifecycle stages so Pi can discover their scoped System tools.

Keep track of work

Run /system board to open the project board and review or change tracked progress. Run /system assess to ask Pi for evidence-backed progress proposals, then review them in the board. Run /system doctor when you want to check System files without changing them. Run /system view <path|id|slug> to read one document or /system book to browse the full project dossier.

The System stores its material in .system/ within your project. It may ask for approval before creating core documents, changing the current phase, editing an approved plan, or changing governed files. Review those prompts before accepting them.

Installation

Reference

Commands

Command Purpose
/system The System project governance

Changelog.

<img src="assets/banner.svg" alt="the-system" height="70">

# The System

The System gives a Pi project a lightweight place for its mission, plans, decisions, and implementation progress.
Use it when work needs shared direction and visible human approval instead of an unstructured stream of prompts.

![the-system demo: init, phase, spec, plan, human approval, exec with board update, doctor, all from /system](assets/demo.gif)

## Start here

Run `/system init MYPROJECT` in the project you want to govern.
Pi shows what it will create or update and asks for approval before changing files.
Restart Pi to load the new project's guidance.
Then run `/system phase` to establish the current working phase, or `/system research <question>` to begin exploring a problem.

```text
/system research How should we support offline imports?
```

Each lifecycle command starts a new Pi turn with your instructions and current project status.
Run `/system spec <goal>` to define what must be true.
Run `/system plan <work>` to prepare a plan, then review and explicitly approve it.
Run `/system exec <work>` to carry out approved work.
Stages do not automatically advance, so you choose each next step.
Enable Pi's `codemode` or `tool_search` when using lifecycle stages so Pi can discover their scoped System tools.

## Keep track of work

Run `/system board` to open the project board and review or change tracked progress.
Run `/system assess` to ask Pi for evidence-backed progress proposals, then review them in the board.
Run `/system doctor` when you want to check System files without changing them.
Run `/system view <path|id|slug>` to read one document or `/system book` to browse the full project dossier.

The System stores its material in `.system/` within your project.
It may ask for approval before creating core documents, changing the current phase, editing an approved plan, or changing governed files.
Review those prompts before accepting them.

[Installation](../../README.md#install)

## Reference

<!-- config:start -->
### Commands

| Command | Purpose |
| --- | --- |
| `/system` | The System project governance |
<!-- config:end -->

[Changelog](./CHANGELOG.md).