thackmaster/routie
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

gitea push

Browse Source
This commit is contained in:
thackmaster
2026-05-09 12:19:29 -06:00
parent 06113c95b8
commit 429461e985
1481 changed files with 74306 additions and 52475 deletions
Download Patch File Download Diff File Expand all files Collapse all files
frontend/node_modules/@intellectronica/ruler/README.md
Generated Vendored
+185 -36
View File
@@ -54,40 +54,40 @@ Ruler solves this by providing a **single source of truth** for all your AI agen
## Supported AI Agents
| Agent | Rules File(s) | MCP Configuration / Notes | Skills Support / Location |
| ---------------------- | ---------------------------------------------- | ------------------------------------------------ | ------------------------- |
| AGENTS.md | `AGENTS.md` | (pseudo-agent ensuring root `AGENTS.md` exists) | - |
| GitHub Copilot | `AGENTS.md` | `.vscode/mcp.json` | `.claude/skills/` |
| Claude Code | `CLAUDE.md` | `.mcp.json` | `.claude/skills/` |
| OpenAI Codex CLI | `AGENTS.md` | `.codex/config.toml` | `.codex/skills/` |
| Pi Coding Agent | `AGENTS.md` | - | `.pi/skills/` |
| Jules | `AGENTS.md` | - | - |
| Cursor | `AGENTS.md` | `.cursor/mcp.json` | `.cursor/skills/` |
| Windsurf | `AGENTS.md` | `.windsurf/mcp_config.json` | `.windsurf/skills/` |
| Cline | `.clinerules` | - | - |
| Crush | `CRUSH.md` | `.crush.json` | - |
| Amp | `AGENTS.md` | - | `.agents/skills/` |
| Antigravity | `.agent/rules/ruler.md` | - | `.agent/skills/` |
| Amazon Q CLI | `.amazonq/rules/ruler_q_rules.md` | `.amazonq/mcp.json` | - |
| Aider | `AGENTS.md`, `.aider.conf.yml` | `.mcp.json` | - |
| Firebase Studio | `.idx/airules.md` | `.idx/mcp.json` | - |
| Open Hands | `.openhands/microagents/repo.md` | `config.toml` | - |
| Gemini CLI | `AGENTS.md` | `.gemini/settings.json` | `.gemini/skills/` |
| Junie | `.junie/guidelines.md` | `.junie/mcp/mcp.json` | `.junie/skills/` |
| AugmentCode | `.augment/rules/ruler_augment_instructions.md` | - | - |
| Kilo Code | `AGENTS.md` | `.kilocode/mcp.json` | `.claude/skills/` |
| OpenCode | `AGENTS.md` | `opencode.json` | `.opencode/skills/` |
| Goose | `.goosehints` | - | `.agents/skills/` |
| Qwen Code | `AGENTS.md` | `.qwen/settings.json` | - |
| RooCode | `AGENTS.md` | `.roo/mcp.json` | `.roo/skills/` |
| Zed | `AGENTS.md` | `.zed/settings.json` (project root, never $HOME) | - |
| Trae AI | `.trae/rules/project_rules.md` | - | - |
| Warp | `WARP.md` | - | - |
| Kiro | `.kiro/steering/ruler_kiro_instructions.md` | `.kiro/settings/mcp.json` | - |
| Firebender | `firebender.json` | `firebender.json` (rules and MCP in same file) | - |
| Factory Droid | `AGENTS.md` | `.factory/mcp.json` | `.factory/skills/` |
| Mistral Vibe | `AGENTS.md` | `.vibe/config.toml` | `.vibe/skills/` |
| JetBrains AI Assistant | `.aiassistant/rules/AGENTS.md` | - | - |
| Agent | Rules File(s) | MCP Configuration / Notes | Skills Support / Location | Subagents Support / Location |
| ---------------------- | ---------------------------------------------- | ------------------------------------------------ | ------------------------- | ---------------------------- |
| AGENTS.md | `AGENTS.md` | (pseudo-agent ensuring root `AGENTS.md` exists) | - | - |
| GitHub Copilot | `AGENTS.md` | `.vscode/mcp.json` | `.claude/skills/` | `.github/agents/` |
| Claude Code | `CLAUDE.md` | `.mcp.json` | `.claude/skills/` | `.claude/agents/` |
| OpenAI Codex CLI | `AGENTS.md` | `.codex/config.toml` | `.codex/skills/` | `.codex/agents/` (`.toml`) |
| Pi Coding Agent | `AGENTS.md` | - | `.pi/skills/` | - |
| Jules | `AGENTS.md` | - | - | - |
| Cursor | `AGENTS.md` | `.cursor/mcp.json` | `.cursor/skills/` | `.cursor/agents/` |
| Windsurf | `AGENTS.md` | `.windsurf/mcp_config.json` | `.windsurf/skills/` | - |
| Cline | `.clinerules` | - | - | - |
| Crush | `CRUSH.md` | `.crush.json` | - | - |
| Amp | `AGENTS.md` | - | `.agents/skills/` | - |
| Antigravity | `.agent/rules/ruler.md` | - | `.agent/skills/` | - |
| Amazon Q CLI | `.amazonq/rules/ruler_q_rules.md` | `.amazonq/mcp.json` | - | - |
| Aider | `AGENTS.md`, `.aider.conf.yml` | `.mcp.json` | - | - |
| Firebase Studio | `.idx/airules.md` | `.idx/mcp.json` | - | - |
| Open Hands | `.openhands/microagents/repo.md` | `config.toml` | - | - |
| Gemini CLI | `AGENTS.md` | `.gemini/settings.json` | `.gemini/skills/` | - |
| Junie | `.junie/guidelines.md` | `.junie/mcp/mcp.json` | `.junie/skills/` | - |
| AugmentCode | `.augment/rules/ruler_augment_instructions.md` | - | - | - |
| Kilo Code | `AGENTS.md` | `.kilocode/mcp.json` | `.claude/skills/` | - |
| OpenCode | `AGENTS.md` | `opencode.json` | `.opencode/skills/` | - |
| Goose | `.goosehints` | - | `.agents/skills/` | - |
| Qwen Code | `AGENTS.md` | `.qwen/settings.json` | - | - |
| RooCode | `AGENTS.md` | `.roo/mcp.json` | `.roo/skills/` | - |
| Zed | `AGENTS.md` | `.zed/settings.json` (project root, never $HOME) | - | - |
| Trae AI | `.trae/rules/project_rules.md` | - | - | - |
| Warp | `WARP.md` | - | - | - |
| Kiro | `.kiro/steering/ruler_kiro_instructions.md` | `.kiro/settings/mcp.json` | - | - |
| Firebender | `firebender.json` | `firebender.json` (rules and MCP in same file) | - | - |
| Factory Droid | `AGENTS.md` | `.factory/mcp.json` | `.factory/skills/` | - |
| Mistral Vibe | `AGENTS.md` | `.vibe/config.toml` | `.vibe/skills/` | - |
| JetBrains AI Assistant | `.aiassistant/rules/AGENTS.md` | - | - | - |
## Getting Started
@@ -241,9 +241,12 @@ The `apply` command looks for `.ruler/` in the current directory tree, reading t
| `--gitignore-local` | Write managed ignore entries to `.git/info/exclude` instead. |
| `--nested` | Enable nested rule loading (default: inherit from config or disabled). |
| `--no-nested` | Disable nested rule loading even if `nested = true` in config. |
| `--backup` | Toggle creation of `.bak` backup files (default: enabled). |
| `--backup` | Enable creation of `.bak` backup files (default: enabled). |
| `--no-backup` | Disable creation of `.bak` backup files. |
| `--skills` | Enable skills support (experimental, default: enabled). |
| `--no-skills` | Disable skills support. |
| `--subagents` | Enable subagents support (experimental, default: enabled). |
| `--no-subagents` | Disable subagents support. |
| `--dry-run` | Preview changes without writing files. |
| `--local-only` | Skip `$XDG_CONFIG_HOME` when looking for configuration. |
| `--verbose` / `-v` | Display detailed output during execution. |
@@ -663,12 +666,13 @@ When skills support is enabled and gitignore integration is active, Ruler automa
- `.gemini/skills/` (for Gemini CLI)
- `.junie/skills/` (for Junie)
- `.cursor/skills/` (for Cursor)
- `.windsurf/skills/` (for Windsurf)
to your `.gitignore` file within the managed Ruler block.
### Requirements
- **For agents with native skills support** (Claude Code, GitHub Copilot, Kilo Code, OpenAI Codex CLI, OpenCode, Pi Coding Agent, Goose, Amp, Antigravity, Factory Droid, Mistral Vibe, Roo Code, Gemini CLI, Junie, Cursor): No additional requirements.
- **For agents with native skills support** (Claude Code, GitHub Copilot, Kilo Code, OpenAI Codex CLI, OpenCode, Pi Coding Agent, Goose, Amp, Antigravity, Factory Droid, Mistral Vibe, Roo Code, Gemini CLI, Junie, Cursor, Windsurf): No additional requirements.
### Validation
@@ -723,8 +727,153 @@ ruler apply
# - Gemini CLI: .gemini/skills/my-skill/
# - Junie: .junie/skills/my-skill/
# - Cursor: .cursor/skills/my-skill/
# - Windsurf: .windsurf/skills/my-skill/
```
## Subagents Support (Experimental)
> **⚠️ Experimental:** Subagents support is experimental and behavior may change in future releases.
Ruler can distribute named, delegatable **subagents** from a single source of truth (`.ruler/agents/`) to each agent's native subagent location. Each source file is one Markdown file with YAML frontmatter; Ruler transforms it into the format the target agent expects.
### How It Works
For agents with a native subagent primitive, Ruler writes one file per subagent into the target directory:
| Agent | Target location | Format |
| ----------------- | ------------------------------ | ------ |
| Claude Code | `.claude/agents/<name>.md` | Markdown + YAML frontmatter |
| Cursor | `.cursor/agents/<name>.md` | Markdown + YAML frontmatter |
| OpenAI Codex CLI | `.codex/agents/<name>.toml` | TOML (one self-contained file per agent) |
| GitHub Copilot | `.github/agents/<name>.md` | Markdown + YAML frontmatter |
Other agents (Windsurf, RooCode, Aider, Gemini CLI, …) do not yet have a comparable native subagent primitive and are skipped with a warning. Subagent propagation will be added when those agents ship a comparable file format.
### Source Format
Author each subagent as `.ruler/agents/<name>.md`:
```markdown
---
name: code-reviewer
description: Use PROACTIVELY after a feature/fix is implemented. Reviews against SOLID/DRY/KISS. Read-only.
tools: [Read, Grep, Glob, Bash]
model: inherit
readonly: true
is_background: false
---
# Code Reviewer
You operate in a fresh context window with read-only access. Your job is to
review the diff and surrounding code against the design principles and return
a structured verdict.
```
**Required frontmatter fields:**
| Field | Type | Notes |
| ------------- | ------ | ----------------------------------------------------- |
| `name` | string | Must match the filename stem (`code-reviewer.md` → `name: code-reviewer`). |
| `description` | string | When the parent agent should delegate to this subagent. |
**Optional frontmatter fields:**
| Field | Type | Used by | Default behavior |
| --------------- | ---------------- | ------------------------------------------------ | --------------------------------------------- |
| `tools` | string[] | Claude (verbatim), Copilot (mapped to aliases) | Cursor / Codex ignore; omitted if absent. |
| `model` | string | All four targets | Cursor defaults to `inherit`; others omit. |
| `readonly` | boolean | Cursor (verbatim), Codex (`sandbox_mode`), Copilot (`disable-model-invocation`) | Defaults to `false` for Cursor; omitted otherwise. |
| `is_background` | boolean | Cursor only | Defaults to `false` for Cursor. |
For GitHub Copilot, source `tools` (Claude vocabulary: `Read`, `Grep`, `Bash`, …) are translated to Copilot's aliases (`read`, `search`, `execute`, …). Tools that do not have a Copilot equivalent are dropped silently on a normal apply; pass `--verbose` (or use `--dry-run` to preview) to see which tools were dropped.
### Configuration
Subagent propagation is **disabled by default**. Opt in via CLI flag or `ruler.toml`:
```bash
ruler apply --subagents # enable subagent propagation for one run
```
```toml
# .ruler/ruler.toml
[agents]
enabled = true
# include_in_rules = true # also append .ruler/agents/*.md into top-level CLAUDE.md / AGENTS.md (default: false)
```
> **Note:** the previous release used `[subagents]` for these keys. `[subagents]` is still honored as a fallback with a deprecation warning, and will be removed in a future release. Please migrate to `[agents]`.
`[agents] enabled` controls only native subagent propagation from `.ruler/agents/`. It is independent from `[agents.<name>] enabled` (which toggles per-coding-agent output like `CLAUDE.md` / `AGENTS.md`).
CLI flags take precedence over `ruler.toml`, which takes precedence over the default (disabled).
### Validation
Source files are validated at discovery time:
- Files without YAML frontmatter are skipped with a warning.
- Files missing required `name` or `description` are skipped with a warning.
- Files where `name` does not match the filename stem are skipped with a warning.
- Unknown frontmatter keys are dropped (not errored).
### Dry-Run Mode
Use `--dry-run` to preview which files would be written without touching disk.
### `.gitignore` Integration
When subagents are enabled, the four target directories are added to the Ruler-managed block of `.gitignore`:
```
.claude/agents/
.cursor/agents/
.codex/agents/
.github/agents/
```
Use `--no-gitignore` to opt out.
### Cleanup
Subagent propagation does **not** currently have explicit `ruler revert` support. To remove generated subagent directories, set `[agents] enabled = false` (or pass `--no-subagents`) and run `ruler apply` once. Cleanup will run for all four targets even if no source `.ruler/agents/` directory exists.
### Example Workflow
```bash
# 1. Author a subagent in your project
mkdir -p .ruler/agents
cat > .ruler/agents/code-reviewer.md << 'EOF'
---
name: code-reviewer
description: Reviews changes against SOLID/DRY/KISS
tools: [Read, Grep, Glob]
readonly: true
---
You review code changes for quality.
EOF
# 2. Opt subagents in (default is disabled — see [agents] section above)
echo -e "\n[agents]\nenabled = true" >> .ruler/ruler.toml
# 3. Apply
ruler apply
# 4. The subagent is now available in each agent's native location:
# - Claude Code: .claude/agents/code-reviewer.md
# - Cursor: .cursor/agents/code-reviewer.md
# - Codex CLI: .codex/agents/code-reviewer.toml
# - GitHub Copilot: .github/agents/code-reviewer.md
```
### Limitations
- **No explicit revert command.** Cleanup happens via `[agents] enabled = false` on a subsequent `apply`.
- **Atomic replace, not merge.** Ruler regenerates each agent's subagent directory from the source on every apply. Manual edits to generated files will be overwritten.
- **No support yet for agents without a native subagent primitive.** Windsurf, RooCode, Aider, Gemini CLI, and others are skipped with a warning. Propagation will be added when those agents ship a comparable file format.
## `.gitignore` Integration
Ruler automatically manages your `.gitignore` file to keep generated agent configuration files out of version control.