@klaudworks/rmr 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,45 @@
1
+ # Ralph Meets Rex
2
+
3
+ ![rmr](docs/images/hero.jpg)
4
+
5
+ Define multi-step coding workflows that match how you actually work. `rmr` orchestrates AI agents through YAML-defined state machines — plan, implement, review, loop — so you can encode your process once and run it on any task.
6
+
7
+ ## Quick Start
8
+
9
+ ```bash
10
+ npm install -g @klaudworks/rmr@latest # install or update
11
+ rmr install feature-dev # add the feature-dev workflow
12
+ rmr run .rmr/workflows/feature-dev/workflow.yaml --task "Implement feature X" # run it
13
+ ```
14
+
15
+ ## Sample Workflows
16
+
17
+ ### [feature-dev](docs/workflows/feature-dev/)
18
+
19
+ Plan, implement, and review a single feature end-to-end — with an automatic revision loop.
20
+
21
+ <p align="center">
22
+ <img src="docs/workflows/feature-dev/flow.svg" width="720" />
23
+ </p>
24
+
25
+ ```bash
26
+ rmr install feature-dev
27
+ rmr run .rmr/workflows/feature-dev/workflow.yaml --task "Add rate limiting to the API"
28
+ ```
29
+
30
+ ## Supported Harnesses
31
+
32
+ | Harness | |
33
+ |---------|:---:|
34
+ | [Claude Code](https://claude.ai/code) | :white_check_mark: |
35
+ | [Codex](https://openai.com/index/codex/) | :x: |
36
+ | [OpenCode](https://opencode.ai) | :x: |
37
+
38
+ ## Commands
39
+
40
+ | Command | Description |
41
+ | ----------------------------- | ---------------------------------------------- |
42
+ | `rmr install <workflow>` | Copy a bundled workflow into `.rmr/workflows/` |
43
+ | `rmr run <path> --task "..."` | Start a new workflow run |
44
+ | `rmr continue <run-id>` | Resume a paused or interrupted run |
45
+ | `rmr completion <shell>` | Print shell completion script |