Skip to content

docs: update CLI commands and dependency types documentation #520

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
kasperjunge wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −11
Open

docs: update CLI commands and dependency types documentation #520

Show file tree
Hide file tree
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
8 changes: 3 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@ uv run agrx --help

Two CLI tools share a common core library:

- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: add, remove, sync, list, init, config.
- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: init, add, remove, sync, upgrade, list, run, config.
- **`agrx`** — Ephemeral skill runner (`agrx/main.py`). Downloads and runs a skill without persisting it.

For detailed architecture, contributing guides, code patterns, and recipes, see `docs/contributing/`.

## agr.toml Format

The configuration file uses a flat array of dependencies:
Expand All @@ -44,11 +42,11 @@ dependencies = [
```

Each dependency has:
- `type`: Always "skill" for now
- `type`: `"skill"` or `"ralph"`. Skills install into each configured tool's skills dir; ralphs install once into `.agents/ralphs/<name>/` (project-scoped, no per-tool fan-out, no global installs).
- `handle`: Remote GitHub reference (username/repo/skill or username/skill)
- `path`: Local path (alternative to handle)

Future: A `tools` section will configure which tools to sync to:
The `tools` section configures which tools to sync to:
```toml
tools = ["claude", "cursor"]
```
Expand Down
4 changes: 1 addition & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@ uv run agrx --help

Two CLI tools share a common core library:

- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: add, remove, sync, list, init, config.
- **`agr`** — Main CLI (Typer app in `agr/main.py`). Commands: init, add, remove, sync, upgrade, list, run, config.
- **`agrx`** — Ephemeral skill runner (`agrx/main.py`). Downloads and runs a skill without persisting it.

For detailed architecture, contributing guides, code patterns, and recipes, see `docs/contributing/`.

## agr.toml Format

The configuration file uses a flat array of dependencies:
Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ cd my-project
agr init
```

Writes a starter `agr.toml` and adds the per-tool skill directories to
`.gitignore`.
Writes a starter `agr.toml`.

### 3. Add a skill

Expand Down
2 changes: 1 addition & 1 deletion docs/managing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Skill directories are built artifacts. Commit the manifest, ignore the build.
.agents/skills/
```

`agr init` writes these for you.
Add these to your project's `.gitignore` manually.

## Multi-tool

Expand Down
Loading