Skip to content

docs: add Quickstart section with install, init, run, and train flow #26

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

Merged
bearmug merged 1 commit into from
May 15, 2026
Merged

docs: add Quickstart section with install, init, run, and train flow #26

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,29 @@

Local project-memory engine for git history.

## Quickstart

```bash
npm install -g @fiale-plus/repo-arch

cd your-project
export OPENAI_API_KEY=sk-... # or GEMINI_API_KEY

repo-arch init # write starter config
repo-arch flow run --repo . # mine history → cards → dataset
repo-arch flow inspect --repo . # see what was produced
```

Then curate and train:

```bash
repo-arch review list # review generated cards
repo-arch accept <card-id> # mark valuable cards
repo-arch train run --repo . # fine-tune on accepted cards
```

Requires Node 18+ and (for training) Apple Silicon with MLX.

Repo-Arch mines repository history, classifies commit signals, builds cards, explains files, warns on diffs, checks staleness, runs similarity search, prepares evals, and generates training data.

## Pi install
Expand Down
Loading