Skip to content

Commit 71f5e76

Browse files
JustAGhosTclaude
andcommitted
docs: rewrite README with Retort explainer and per-IDE feature summary
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 630f3f7 commit 71f5e76

1 file changed

Lines changed: 66 additions & 37 deletions

File tree

README.md

Lines changed: 66 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,101 @@
11
# retort-plugins
22

3-
IDE plugins for the [Retort](https://github.com/phoenixvc/retort) framework — command palette, sidebar, status bar, and AI context injection across VS Code, JetBrains, and Zed.
3+
IDE plugins for the [Retort](https://github.com/phoenixvc/retort) framework.
4+
5+
## What is Retort?
6+
7+
Every AI coding assistant has its own config format — `CLAUDE.md`, `.cursor/rules/`, `.windsurf/rules/`, `.junie/guidelines.md`, `AGENTS.md`, and more. Keeping them in sync by hand means duplicated effort and drift.
8+
9+
**Retort** solves this: describe your project once in YAML, run `retort sync`, and get correct, project-aware configs for all 16 supported AI tools — automatically, on every sync.
10+
11+
```
12+
.agentkit/spec/project.yaml ← describe your project once
13+
.agentkit/spec/teams.yaml ← agent teams and their scopes
14+
.agentkit/spec/rules.yaml ← coding rules by domain
15+
16+
retort sync
17+
18+
CLAUDE.md .claude/ .cursor/ .windsurf/ .junie/ AGENTS.md ...
19+
```
20+
21+
These plugins bring Retort into your IDE — so you can trigger syncs, run quality gates, check orchestration status, and ask your AI assistant about the active team and tasks, all without leaving your editor.
422

523
## Extensions
624

725
| Extension | IDE | AI Integration |
826
|-----------|-----|----------------|
927
| [`extensions/vscode`](extensions/vscode/) | VS Code 1.90+ | `@retort` Copilot Chat participant |
10-
| [`extensions/pycharm`](extensions/pycharm/) | PyCharm, IntelliJ IDEA, Rider 2023.3+ | Junie (optional, pre-wired) |
28+
| [`extensions/pycharm`](extensions/pycharm/) | PyCharm · IntelliJ IDEA · Rider 2023.3+ | Junie context injection (optional) |
1129
| [`extensions/zed`](extensions/zed/) | Zed | `/retort-*` slash commands |
1230

13-
All three extensions activate automatically when a `.agentkit/` directory is present at the workspace root.
31+
All three activate automatically when `.agentkit/` is present at the workspace root.
1432

15-
## Packages
33+
### What you get in each IDE
1634

17-
Internal shared packages consumed by the VS Code extension:
35+
**VS Code**
36+
- Command palette: `Ctrl+Shift+P``Retort: ...` (Sync, Check, Orchestrate, Plan, …)
37+
- Sidebar dashboard: in-progress tasks, team roster, quick-launch buttons
38+
- Status bar: active phase + sync shortcut
39+
- `@retort` in Copilot Chat: `/status`, `/teams`, `/backlog` — workspace context injected automatically
1840

19-
| Package | Description |
20-
|---------|-------------|
21-
| [`packages/state-watcher`](packages/state-watcher/) | WebSocket daemon — watches `.claude/state/` and `.agentkit/` files, streams state to the extension |
22-
| [`packages/router`](packages/router/) | Keyword-based team/agent routing — answers natural-language questions about agent teams |
23-
| [`packages/ui`](packages/ui/) | React webview — sidebar dashboard rendered inside VS Code |
41+
**JetBrains (PyCharm / IntelliJ / Rider)**
42+
- **Tools → Retort** menu with all commands
43+
- Tool window: phase, tasks, quick-launch grid, **Copy Workspace Context** button
44+
- Status bar widget
45+
- Junie integration pre-wired — activates once JetBrains publishes the stable context API
46+
47+
**Zed**
48+
- `/retort-status`, `/retort-teams`, `/retort-backlog`, `/retort-sync` in the AI assistant panel
2449

2550
## Getting Started
2651

2752
See [`docs/onboarding/`](docs/onboarding/) for per-IDE install and usage guides:
2853

2954
- [VS Code](docs/onboarding/vscode.md)
30-
- [JetBrains](docs/onboarding/jetbrains.md) — PyCharm, IntelliJ IDEA, Rider
55+
- [JetBrains](docs/onboarding/jetbrains.md)
3156
- [Zed](docs/onboarding/zed.md)
3257

58+
> **New to Retort?** Start with the [Retort repo](https://github.com/phoenixvc/retort)
59+
> run `npx retort init` in your project first, then install the plugin for your IDE.
60+
61+
## Internal Packages
62+
63+
The VS Code extension is built on three shared packages:
64+
65+
| Package | Description |
66+
|---------|-------------|
67+
| [`packages/state-watcher`](packages/state-watcher/) | WebSocket daemon — watches `.claude/state/` and `.agentkit/` files, streams live state to the extension |
68+
| [`packages/router`](packages/router/) | Keyword-based team/agent routing — powers natural-language questions about agent teams |
69+
| [`packages/ui`](packages/ui/) | React webview — the sidebar dashboard rendered inside VS Code |
70+
3371
## Development
3472

3573
### Prerequisites
3674

37-
- Node.js 20+, npm (VS Code extension and shared packages)
38-
- JDK 17+, Gradle (JetBrains plugin)
39-
- Rust stable (Zed extension)
75+
| Stack | Required for |
76+
|-------|-------------|
77+
| Node.js 20+, npm | VS Code extension + shared packages |
78+
| JDK 17+, Gradle | JetBrains plugin |
79+
| Rust stable | Zed extension |
4080

41-
### Build all JS packages and the VS Code extension
81+
### Build
4282

4383
```bash
84+
# VS Code extension + all shared packages
4485
npm install
4586
npm run build
46-
```
4787

48-
### Build the JetBrains plugin
49-
50-
```bash
88+
# JetBrains plugin
5189
cd extensions/pycharm
52-
./gradlew buildPlugin
53-
# output: build/distributions/retort-*.zip
54-
```
90+
./gradlew buildPlugin # → build/distributions/retort-*.zip
91+
./gradlew runIde # launch a sandboxed IDE with the plugin loaded
5592

56-
Run in a sandboxed IDE:
57-
58-
```bash
59-
./gradlew runIde
60-
```
61-
62-
### Build the Zed extension
63-
64-
```bash
93+
# Zed extension
6594
cd extensions/zed
6695
cargo build --release
6796
```
6897

69-
### Lint and typecheck (JS)
98+
### Lint and typecheck
7099

71100
```bash
72101
npm run lint
@@ -78,20 +107,20 @@ npm run typecheck
78107
```
79108
retort-plugins/
80109
├── extensions/
81-
│ ├── pycharm/ # JetBrains plugin (Kotlin/Gradle)
110+
│ ├── pycharm/ # JetBrains plugin (Kotlin + Gradle)
82111
│ ├── vscode/ # VS Code extension (TypeScript)
83112
│ └── zed/ # Zed extension (Rust)
84113
├── packages/
114+
│ ├── state-watcher/ # File-watch WebSocket daemon
85115
│ ├── router/ # Team routing logic
86-
│ ├── state-watcher/ # File-watch daemon
87-
│ └── ui/ # React sidebar
116+
│ └── ui/ # React sidebar webview
88117
└── docs/
89-
└── onboarding/ # Per-IDE install guides
118+
└── onboarding/ # Per-IDE install and usage guides
90119
```
91120

92121
## Contributing
93122

94-
PRs target `main`. Conventional Commits required — CI enforces the title format.
123+
PRs target `main`. Titles must follow [Conventional Commits](https://www.conventionalcommits.org/) — CI enforces this.
95124

96125
## License
97126

0 commit comments

Comments
 (0)