xiaoju
d63d58ccb5
- Move 15 old workflow-* packages to legacy-packages/ (inactive, preserved for reference)
- Rename templates/ → examples/ for clarity
- Rewrite docs/architecture.md to reflect current uwf architecture
- Active packages remain in packages/: cli-uwf, uwf-agent-hermes, uwf-agent-kit, uwf-moderator, uwf-protocol, workflow-util
小橘 🍊（NEKO Team）
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# @uncaged/workflow-agent-cursor
|
|
|
|
`AgentFn` adapter that runs the `cursor-agent` CLI against a workspace path derived from the thread.
|
|
|
|
The agent builds a full prompt (system + task + step history via `@uncaged/workflow-util-agent`), extracts the absolute workspace path with your `extract` + Zod schema, then spawns `cursor-agent` with `--workspace`, model, and non-interactive flags.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
bun add @uncaged/workflow-agent-cursor @uncaged/workflow-runtime @uncaged/workflow-util-agent zod
|
|
```
|
|
|
|
In this monorepo: `"@uncaged/workflow-agent-cursor": "workspace:*"` plus `workspace:*` for `@uncaged/workflow-runtime` and `@uncaged/workflow-util-agent`, and `zod` ^4.
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { createCursorAgent } from "@uncaged/workflow-agent-cursor";
|
|
|
|
const agent = createCursorAgent({
|
|
model: null, // null → "auto"
|
|
timeout: 0, // ms; 0 = no limit (spawnCli timeout disabled)
|
|
extract: myExtractFn,
|
|
});
|
|
```
|
|
|
|
## API overview
|
|
|
|
| Export | Description |
|
|
|--------|-------------|
|
|
| `createCursorAgent(config)` | Returns `AgentFn` that runs `cursor-agent` with `buildAgentPrompt(ctx)` from `@uncaged/workflow-util-agent` |
|
|
| `CursorAgentConfig` | `model`, `timeout`, `extract` (must supply workspace path) |
|
|
| `validateCursorAgentConfig` | Config validation result |
|
|
|
|
Requires `cursor-agent` on `PATH` at runtime.
|