Package Exports
- omcursor-workflow
- omcursor-workflow/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (omcursor-workflow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
omx-cursor
omx-cursor is a workflow layer for Cursor CLI.
It keeps Cursor CLI as the execution engine and makes it easier to:
- start stronger sessions by default
- run one consistent flow from clarification to completion
- invoke canonical workflows with
$deep-interview,$ralplan,$team, and$ralph - keep project guidance, plans, logs, and state in
.omx/
Reference And Attribution
This repository is a Cursor CLI-focused fork and adaptation of the original project:
This README's product framing and usage model are authored for omx-cursor usage, and are informed by these sources:
- OMX runtime contract and orchestration policy in AGENTS.md
- OMX command surfaces and behavior in src/cli/index.ts
- Existing OMX docs set in docs/getting-started.html and docs/skills.html
This fork keeps compatibility paths such as .codex/ and CODEX_HOME where required by runtime behavior, while adapting workflows for Cursor CLI.
Legacy Team Listings (Historical Reference)
These listings are preserved as historical reference only.
New Usage Guide
0) Install From npm (Recommended)
npm install -g omcursor-workflow
omcursor setup
omcursor doctor1) Clone And Install Dependencies (Source Only)
git clone https://github.com/krisadas/omx-cursor
cd omx-cursor
npm install
npm audit fix
npm run buildWhat this does:
- installs local dependencies
- builds
dist/outputs from this source tree - prepares runnable local CLI entrypoint at
dist/cli/omx.js
2) Initialize Runtime Assets From Source Build
omcursor setup
omcursor doctorEquivalent source-tree direct commands:
node dist/cli/omx.js setup
node dist/cli/omx.js doctor3) Start A Session (From This Source Tree)
Default interactive session:
omcursorHigh reasoning + permissive approvals (trusted environments only):
omcursor --high --madmaxDetached tmux leader session:
omcursor --tmux --high --madmax4) Use The Core Flow In Session
Use this sequence for most complex work:
$deep-interview "clarify requirements and boundaries"
$ralplan "approve architecture, risks, and tests"
$ralph "execute end-to-end with verification"When execution is parallelizable, switch to team mode:
$team 3:executor "implement approved plan in parallel lanes"5) Daily Command Patterns (Source Build)
Repository exploration:
omcursor explore --prompt "find where worker launch args are normalized"Bounded shell verification:
omcursor sparkshell git status
omcursor sparkshell --tmux-pane %12 --tail-lines 300Team runtime operations:
omcursor team 4:executor "fix build and failing tests"
omcursor team status <team-name>
omcursor team resume <team-name>
omcursor team shutdown <team-name>6) Runtime Model
Think of OMX in three layers:
- Cursor CLI runs the core agent execution
- OMX adds orchestration workflows and guardrails
.omx/persists plans, state, logs, and runtime metadata
7) Environment Requirements
- Node.js 20+
- Cursor CLI installed and authenticated in your environment
tmuxon macOS/Linux for team modepsmuxon Windows for native team mode
8) Operational Tips
- Use
npm run setupafter upgrades to refresh managed assets - Use
npm run doctorfirst when something looks inconsistent - Keep
AGENTS.mdin repo root for project-specific orchestration policy - Prefer
$ralplanbefore$team/$ralphfor large or risky changes
9) Known Startup Issue (Intel Mac)
If startup causes high syspolicyd / trustd CPU on Intel Macs:
- run
xattr -dr com.apple.quarantine $(which omcursor)(if you also use a global install) - add your terminal to Developer Tools in macOS security settings
- reduce launch aggressiveness (for example, skip
--madmax --high)
Local Project References
Languages
Contributors
| Role | Name | GitHub |
|---|---|---|
| Fork Owner & Maintainer | Krisada | @krisadas |
License
MIT