@litmers/cursorflow-orchestrator 0.1.9 → 0.1.13
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/CHANGELOG.md +30 -0
- package/README.md +90 -72
- package/commands/cursorflow-clean.md +24 -135
- package/commands/cursorflow-doctor.md +66 -38
- package/commands/cursorflow-init.md +33 -50
- package/commands/cursorflow-models.md +51 -0
- package/commands/cursorflow-monitor.md +52 -72
- package/commands/cursorflow-prepare.md +426 -147
- package/commands/cursorflow-resume.md +51 -159
- package/commands/cursorflow-review.md +38 -202
- package/commands/cursorflow-run.md +197 -84
- package/commands/cursorflow-signal.md +27 -72
- package/dist/cli/clean.js +23 -0
- package/dist/cli/clean.js.map +1 -1
- package/dist/cli/doctor.js +14 -1
- package/dist/cli/doctor.js.map +1 -1
- package/dist/cli/index.js +14 -3
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/init.js +5 -4
- package/dist/cli/init.js.map +1 -1
- package/dist/cli/models.d.ts +7 -0
- package/dist/cli/models.js +104 -0
- package/dist/cli/models.js.map +1 -0
- package/dist/cli/monitor.js +17 -0
- package/dist/cli/monitor.js.map +1 -1
- package/dist/cli/prepare.d.ts +7 -0
- package/dist/cli/prepare.js +748 -0
- package/dist/cli/prepare.js.map +1 -0
- package/dist/cli/resume.js +56 -0
- package/dist/cli/resume.js.map +1 -1
- package/dist/cli/run.js +30 -1
- package/dist/cli/run.js.map +1 -1
- package/dist/cli/signal.js +18 -0
- package/dist/cli/signal.js.map +1 -1
- package/dist/utils/cursor-agent.d.ts +4 -0
- package/dist/utils/cursor-agent.js +58 -10
- package/dist/utils/cursor-agent.js.map +1 -1
- package/dist/utils/doctor.d.ts +10 -0
- package/dist/utils/doctor.js +588 -1
- package/dist/utils/doctor.js.map +1 -1
- package/dist/utils/types.d.ts +2 -0
- package/examples/README.md +114 -59
- package/examples/demo-project/README.md +61 -79
- package/examples/demo-project/_cursorflow/tasks/demo-test/01-create-utils.json +17 -6
- package/examples/demo-project/_cursorflow/tasks/demo-test/02-add-tests.json +17 -6
- package/examples/demo-project/_cursorflow/tasks/demo-test/README.md +66 -25
- package/package.json +1 -1
- package/src/cli/clean.ts +27 -0
- package/src/cli/doctor.ts +18 -2
- package/src/cli/index.ts +15 -3
- package/src/cli/init.ts +6 -4
- package/src/cli/models.ts +83 -0
- package/src/cli/monitor.ts +20 -0
- package/src/cli/prepare.ts +844 -0
- package/src/cli/resume.ts +66 -0
- package/src/cli/run.ts +36 -2
- package/src/cli/signal.ts +22 -0
- package/src/utils/cursor-agent.ts +62 -10
- package/src/utils/doctor.ts +643 -5
- package/src/utils/types.ts +2 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# CursorFlow Models
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
List available AI models supported by CursorFlow and their recommended use cases. These models are discovered from your local `cursor-agent` installation.
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
cursorflow models [options]
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Options
|
|
13
|
+
|
|
14
|
+
| Option | Description |
|
|
15
|
+
|------|------|
|
|
16
|
+
| `--list`, `-l` | List models in a table (default) |
|
|
17
|
+
| `--json` | Output model list as JSON |
|
|
18
|
+
|
|
19
|
+
## Available Models
|
|
20
|
+
|
|
21
|
+
| ID | Name | Provider | Recommended Use |
|
|
22
|
+
|----|------|----------|-----------------|
|
|
23
|
+
| `sonnet-4.5` | Claude 3.7 Sonnet | Anthropic | General implementation, fast work (Most versatile) |
|
|
24
|
+
| `sonnet-4.5-thinking` | Claude 3.7 Sonnet (Thinking) | Anthropic | Code review, deeper reasoning (Thinking model) |
|
|
25
|
+
| `opus-4.5` | Claude 4.0 Opus | Anthropic | Complex tasks, high quality (Advanced) |
|
|
26
|
+
| `opus-4.5-thinking` | Claude 4.0 Opus (Thinking) | Anthropic | Architecture design (Premium) |
|
|
27
|
+
| `gpt-5.2` | GPT-5.2 | OpenAI | General tasks |
|
|
28
|
+
| `gpt-5.2-high` | GPT-5.2 High Reasoning | OpenAI | Advanced reasoning (High performance) |
|
|
29
|
+
|
|
30
|
+
## Model Configuration
|
|
31
|
+
|
|
32
|
+
In your task `.json` files, specify the model like this:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"model": "sonnet-4.5",
|
|
37
|
+
"tasks": [
|
|
38
|
+
{
|
|
39
|
+
"name": "implement",
|
|
40
|
+
"prompt": "..."
|
|
41
|
+
}
|
|
42
|
+
]
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Tips
|
|
47
|
+
|
|
48
|
+
- Use the `ID` from the `cursorflow models` output in your JSON files.
|
|
49
|
+
- You can set a default model in `cursorflow.config.js`.
|
|
50
|
+
- Individual tasks within a lane can override the lane-level model.
|
|
51
|
+
|
|
@@ -3,87 +3,67 @@
|
|
|
3
3
|
## Overview
|
|
4
4
|
The `cursorflow monitor` command provides a powerful, interactive terminal-based dashboard to track the execution status of all lanes in real-time. It allows you to visualize dependencies, stream live terminal output, and intervene in running tasks.
|
|
5
5
|
|
|
6
|
-
##
|
|
7
|
-
|
|
8
|
-
1. **Launch the interactive dashboard**
|
|
9
|
-
```bash
|
|
10
|
-
# Monitor the most recent run
|
|
11
|
-
cursorflow monitor latest
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
2. **Dashboard Controls**
|
|
15
|
-
- **Navigation**: Use `↑` and `↓` to move between lanes.
|
|
16
|
-
- **Details**: Press `→` or `Enter` to see task progress, conversation history, and more.
|
|
17
|
-
- **Flow View**: Press `F` (from list view) to see the Directed Acyclic Graph (DAG) of task dependencies.
|
|
18
|
-
- **Live Terminal**: Press `T` (from lane detail) to stream the real-time output of the AI agent.
|
|
19
|
-
- **Intervention**: Press `I` (from lane detail) to send a manual prompt to a running agent.
|
|
20
|
-
- **Kill Process**: Press `K` (from lane detail) to forcefully terminate a stuck agent.
|
|
21
|
-
- **Back**: Use `←` or `Esc` to navigate back to previous screens.
|
|
22
|
-
- **Quit**: Press `Q` to exit.
|
|
23
|
-
|
|
24
|
-
3. **Monitor a specific run directory**
|
|
25
|
-
```bash
|
|
26
|
-
cursorflow monitor _cursorflow/logs/runs/run-2025-12-21T10-00-00
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Key Views
|
|
30
|
-
|
|
31
|
-
### List View
|
|
32
|
-
Shows an overview of all lanes, their status (pending, running, completed, failed, blocked), progress percentage, elapsed time, and "Next Action" (what it's waiting for or what it unlocks).
|
|
6
|
+
## Usage
|
|
33
7
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
### Lane Detail View
|
|
38
|
-
Displays:
|
|
39
|
-
- **Status & Progress**: Current task index and total tasks.
|
|
40
|
-
- **PID**: The process ID of the running `cursor-agent`.
|
|
41
|
-
- **Live Terminal (Preview)**: The last few lines of the agent's output.
|
|
42
|
-
- **Conversation History**: A scrollable list of messages between the system and the agent. Select a message to see its full content.
|
|
43
|
-
|
|
44
|
-
### Full Terminal View
|
|
45
|
-
A dedicated view that acts like `tail -f` for the agent's log. You can scroll up/down through the history using `↑` and `↓`.
|
|
8
|
+
```bash
|
|
9
|
+
# Monitor the most recent run
|
|
10
|
+
cursorflow monitor latest
|
|
46
11
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
⏱ Heartbeat: 30s elapsed, 1234 bytes received
|
|
51
|
-
⏱ Heartbeat: 60s elapsed, 5678 bytes received
|
|
12
|
+
# Monitor a specific run directory
|
|
13
|
+
cursorflow monitor _cursorflow/logs/runs/run-2025-12-21T10-00-00
|
|
52
14
|
```
|
|
53
15
|
|
|
54
|
-
|
|
55
|
-
- Track progress of long-running tasks
|
|
56
|
-
- Identify stalled or hanging processes (0 bytes received)
|
|
57
|
-
- Estimate completion time
|
|
16
|
+
## Dashboard Controls
|
|
58
17
|
|
|
59
|
-
|
|
18
|
+
### List View (Main)
|
|
19
|
+
- **Navigation**: Use `↑` and `↓` to move between lanes.
|
|
20
|
+
- **Details**: Press `→` or `Enter` to enter the **Lane Detail View**.
|
|
21
|
+
- **Flow View**: Press `F` to see the task dependency graph (DAG).
|
|
22
|
+
- **Quit**: Press `Q` to exit.
|
|
60
23
|
|
|
61
|
-
### Lane
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
24
|
+
### Lane Detail View
|
|
25
|
+
- **History Browsing**: Use `↑` and `↓` to scroll through conversation history.
|
|
26
|
+
- **Message Detail**: Press `→` or `Enter` on a message to see its full content.
|
|
27
|
+
- **Live Terminal**: Press `T` to enter the **Full Terminal View**.
|
|
28
|
+
- **Intervention**: Press `I` to send a manual prompt to the agent (requires `enableIntervention: true`).
|
|
29
|
+
- **Kill Process**: Press `K` to forcefully terminate a stuck agent process.
|
|
30
|
+
- **Back**: Press `←` or `Esc` to return to the List View.
|
|
66
31
|
|
|
67
|
-
###
|
|
68
|
-
|
|
32
|
+
### Full Terminal View
|
|
33
|
+
- **Scrolling**: Use `↑` and `↓` to scroll through the entire agent output log.
|
|
34
|
+
- **Back**: Press `T`, `←`, or `Esc` to return to the Lane Detail View.
|
|
35
|
+
|
|
36
|
+
### Intervention View
|
|
37
|
+
- **Typing**: Type your message directly.
|
|
38
|
+
- **Send**: Press `Enter` to send the intervention message.
|
|
39
|
+
- **Cancel**: Press `Esc` to cancel and return.
|
|
40
|
+
|
|
41
|
+
## Key Concepts
|
|
42
|
+
|
|
43
|
+
### Lane Statuses
|
|
44
|
+
| Status | Icon | Description |
|
|
45
|
+
|--------|------|-------------|
|
|
46
|
+
| `pending` | ⚪ | Lane is waiting to start |
|
|
47
|
+
| `waiting` | ⏳ | Waiting for parent dependencies to complete |
|
|
48
|
+
| `running` | 🔄 | Agent is currently executing tasks |
|
|
49
|
+
| `reviewing` | 👀 | AI Reviewer is checking the task results |
|
|
50
|
+
| `completed` | ✅ | All tasks and reviews finished successfully |
|
|
51
|
+
| `failed` | ❌ | A task or review failed with an error |
|
|
52
|
+
| `blocked` | 🚫 | Blocked by a failed dependency |
|
|
69
53
|
|
|
70
|
-
|
|
54
|
+
### Dependency Flow View
|
|
55
|
+
A visual representation of the Directed Acyclic Graph (DAG). It shows which lanes must finish before others can start, helping you understand the execution pipeline.
|
|
71
56
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
3. Type your instructions (e.g., "Don't change the package.json, just fix the bug in utils.ts").
|
|
75
|
-
4. Press `Enter` to send.
|
|
57
|
+
### Heartbeat Logs
|
|
58
|
+
CursorFlow monitors agent activity and logs status every few seconds. If a lane shows `0 bytes received` for a long period, it may be stuck or thinking deeply.
|
|
76
59
|
|
|
77
|
-
|
|
60
|
+
## Troubleshooting
|
|
78
61
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
}
|
|
85
|
-
```
|
|
62
|
+
### Lane is stuck
|
|
63
|
+
1. Enter the **Lane Detail View**.
|
|
64
|
+
2. Check the **PID** to ensure the process is still alive.
|
|
65
|
+
3. Check the **Live Terminal** preview or enter **Full Terminal View (T)**.
|
|
66
|
+
4. If it's truly stuck, press `K` to kill it, then use `cursorflow resume <lane>` to restart.
|
|
86
67
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
2. Use `cursorflow clean` to remove temporary worktrees after you've merged the changes.
|
|
68
|
+
### Sending Instructions
|
|
69
|
+
If the agent is heading in the wrong direction, use the **Intervention (I)** feature to guide it without stopping the run. Note that this requires `enableIntervention: true` in the task's JSON configuration.
|