ultracode-for-codex
v0.3.4
Published
Run Codex-native Ultracode orchestration with an optional local CLI runtime.
Maintainers
Readme
Ultracode for Codex
Dynamic workflows redesigned for Codex, with parallel subagents, visible progress, and an optional local CLI runtime.
The default experience is Codex-native: you ask for $ultracode-for-codex, and
the main Codex chat becomes the orchestrator. It plans the next useful phase,
runs independent subagents in parallel when that helps, summarizes their
findings, and shows compact progress snapshots directly in the conversation.
A local CLI runtime is included for users who want background jobs, reproducible workflow runs, package checks, or attached terminal execution.
Why Use It
- Get multi-angle reviews instead of a single linear pass.
- Run implementation and verification work phase by phase.
- See what agents are doing, what finished, and what still needs attention.
- Keep long CLI workflows running in the OS background when desired.
- Package the same workflow behavior for repeatable local use.
Install
For one project:
npm install --save-dev ultracode-for-codexFor global use:
npm install -g ultracode-for-codexIf you installed it globally, check the CLI directly:
ultracode-for-codex --version
ultracode-for-codex --llm-guideIf you installed it as a project dependency, check it with npm exec --:
npm exec -- ultracode-for-codex --version
npm exec -- ultracode-for-codex --llm-guideInstall The Codex Skills
After installing the npm package, copy the included skill commands into your Codex skills folder.
From a project install:
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
cp -R ./node_modules/ultracode-for-codex/skills/ultracode-for-codex \
"${CODEX_HOME:-$HOME/.codex}/skills/"
cp -R ./node_modules/ultracode-for-codex/skills/ultracode-for-codex-cli \
"${CODEX_HOME:-$HOME/.codex}/skills/"From a global install:
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
GLOBAL_NODE_MODULES="$(npm root -g)"
cp -R "$GLOBAL_NODE_MODULES/ultracode-for-codex/skills/ultracode-for-codex" \
"${CODEX_HOME:-$HOME/.codex}/skills/"
cp -R "$GLOBAL_NODE_MODULES/ultracode-for-codex/skills/ultracode-for-codex-cli" \
"${CODEX_HOME:-$HOME/.codex}/skills/"Restart Codex or start a new Codex session if the skills do not appear immediately.
Use In Codex
Use the default skill for normal work:
$ultracode-for-codex Review this change for correctness and security risks.Good tasks for the default skill:
- code review;
- implementation planning;
- multi-step verification;
- architecture or design critique;
- release readiness checks;
- work that benefits from parallel perspectives.
The default skill shows a phase plan before work starts and keeps a cumulative progress snapshot as agents finish.
Example:
Phase Review
+ Runtime correctness done no material issue
> Security boundary running checking local state handling
- Package contract queued verify installed files
Agents 1 completed | 1 running | 1 queued
Next: synthesize material findingsUse The CLI Runtime
Use $ultracode-for-codex-cli or the ultracode-for-codex binary when you
explicitly want a local command-owned workflow run.
Run a built-in task workflow:
npm exec -- ultracode-for-codex run \
--accept-llm-guide=v1 \
--cwd /path/to/project \
--name task \
--args '{"prompt":"review correctness risks and propose fixes"}'Run a code review:
npm exec -- ultracode-for-codex run \
--accept-llm-guide=v1 \
--cwd /path/to/project \
--name code-review \
--args '{"prompt":"review the current change"}'The built-in code-review workflow collects bounded repository evidence,
chooses review lenses, runs finder agents in parallel, verifies each candidate,
and returns JSON with findings, provenance, synthesis, and stats.
Use {"level":"high"} to skip the final sweep, or omit it for the default
xhigh review.
CLI runs use OS background execution by default. The command prints a launch
record with a jobId, then you can inspect or control the job:
npm exec -- ultracode-for-codex status <jobId> --cwd /path/to/project
npm exec -- ultracode-for-codex logs <jobId> --cwd /path/to/project --tail 40
npm exec -- ultracode-for-codex result <jobId> --cwd /path/to/project
npm exec -- ultracode-for-codex cancel <jobId> --cwd /path/to/projectUse attached execution only when the terminal should stay connected until the workflow finishes:
npm exec -- ultracode-for-codex run \
--accept-llm-guide=v1 \
--execution attached \
--cwd /path/to/project \
--name task \
--args '{"prompt":"check the release plan"}'Resume a completed local workflow from preserved runtime state:
npm exec -- ultracode-for-codex run \
--accept-llm-guide=v1 \
--execution attached \
--cwd /path/to/project \
--resume-from-run-id run_...What Gets Installed
The package includes:
ultracode-for-codex: the local CLI binary;skills/ultracode-for-codex: the recommended Codex-native skill;skills/ultracode-for-codex-cli: the explicit CLI/runtime skill;settings.json: default CLI runtime settings;ULTRACODE_INSTALL.md: detailed install and operating guide for agents.
Local State
CLI runs write workflow state under ${ULTRACODE_FOR_CODEX_HOME:-~/.ultracode-for-codex}.
The runtime keeps background metadata, journals, transcripts, generated scripts,
and results outside the target project so review evidence stays focused on the
workspace itself.
Project workflow sources may still live in .codex/workflows/. If an older
workspace already has .ultracode-for-codex/, keep it ignored and treat it as
legacy sensitive local data:
.ultracode-for-codex/Troubleshooting
If Codex does not recognize $ultracode-for-codex, confirm that the skill
folder exists:
ls "${CODEX_HOME:-$HOME/.codex}/skills/ultracode-for-codex"If npm exec -- ultracode-for-codex fails, confirm the package is installed:
npm ls ultracode-for-codexIf a CLI workflow is still running, list local jobs:
npm exec -- ultracode-for-codex jobs --cwd /path/to/projectFor Maintainers
Common source checkout commands:
npm install
npm test
npm run test:e2e:ultracode-for-codex
npm run test:all
npm run pack:ultracode-for-codexCheck the publish payload:
npm run publish:dry-runMore Documentation
ULTRACODE_INSTALL.md: detailed install and operating guide.skills/ultracode-for-codex/SKILL.md: Codex-native orchestration behavior.skills/ultracode-for-codex/references/progress-visuals.md: progress display examples.skills/ultracode-for-codex-cli/SKILL.md: CLI runtime behavior.
