package
codemix command line interface
npm install codemixGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
CLI for Codemix, optimized for both humans and agents.
npm install -g codemixOr run without global install:
npx codemix@latest --helpcodemix login
codemix init --project your-org/your-project
codemix ask "What does the onboarding flow do?"Install the codemix-cli skill with the skills CLI:
# Install from GitHub to Codex
npx skills add https://github.com/codemix/cli --skill codemix-cli -a codex
# Install from a local codemix/cli checkout (run from repo root)
npx skills add . --skill codemix-cli -a codexUse -g to install globally (available across projects):
npx skills add https://github.com/codemix/cli --skill codemix-cli -a codex -gTop-level commands:
codemix logincodemix logoutcodemix whoamicodemix initcodemix askcodemix discovercodemix taskcodemix help [command]Global options:
-V, --version--non-interactive disable prompts and interactive flows-h, --helpcodemix login [options]Authenticate with Codemix.
Options:
--api-url <url> override Codemix base URL--api-key <key> store an API key directly--port <port> local OAuth callback port (default: 8399)--no-browser do not open browser automatically--json output structured JSONNotes:
CODEMIX_API_KEY is set, login is skipped.--api-key (or CODEMIX_API_KEY) is required.codemix logout [options]Remove stored credentials.
Options:
--api-url <url> override Codemix base URL--json output structured JSONNote: if CODEMIX_API_KEY is set, stored credentials are not modified.
codemix whoami [options]Show current authenticated user.
Options:
--api-url <url> override Codemix base URL--api-key <key> use this API key for this command only--json output structured JSONcodemix init [options]Create or update codemix.jsonc.
Also ensures .codemix/ is present in .gitignore.
Options:
--project <organization/project> set project identifier--api-url <url> persist API URL override in config--api-key <key> use this API key for this command only (for interactive org/project selection)--json output structured JSONcodemix ask [options] <question...>Ask Codemix a question about the project.
Options:
--project <organization/project> override project identifier--api-url <url> override Codemix base URL--api-key <key> use this API key for this command only--no-stream disable SSE streaming and wait for full response--json output structured JSONcodemix discover [options]Run local discovery using your local AI tooling and write artifacts under .codemix.
Current behavior:
.codemix/existing.codemix/refined from that baselineclaude, cursor-agent, or codex) to update/add markdown in .codemix/refined.codemix/summary.jsonnew + updated markdown files only)Options:
--project <organization/project> override project identifier--api-url <url> override Codemix base URL--api-key <key> use this API key for this command only--ai <tool> local AI tool (claude, cursor-agent, or codex; aliases: cursor, agent, codex-cli); required in non-interactive mode. If omitted in interactive mode, you'll be prompted to choose.--create-proposal create draft proposal from changed markdown upserts--proposal-title <title> override generated proposal title--proposal-description <description> override generated proposal description--no-browser do not auto-open browser after proposal creation (interactive mode only)--json output structured JSONcodemix task [options]Show task dashboard.
Task-scope options (supported by task and inherited by subcommands):
--project <organization/project> override project identifier--api-url <url> override Codemix base URL--api-key <key> use this API key for this command only--json output structured JSONSubcommands:
codemix task list [options]List tasks.
Options:
--status <status> filter by status--assignee <assignee> filter by assigneeTypical statuses include: ready, running, needs_input, planning, blocked, completed, failed, cancelled.
In interactive terminals, task list prompts you to pick a task and shows full details. In non-interactive mode, it prints a compact table.
codemix task show <id>Show task details.
codemix task next [options]Claim next available task and emit markdown prompt.
Options:
--no-prompt claim only (do not emit prompt)--wait poll until a task is availablecodemix task claim <id>Claim a specific task.
codemix task unclaim [id]Unclaim a task. If id is omitted, uses your currently claimed running task.
codemix task prompt [id]Emit task description as markdown prompt. If id is omitted, uses your currently claimed running task.
codemix task complete [id]Complete a task. If id is omitted, uses your currently claimed running task.
You can pipe a completion summary through stdin:
echo "Implemented and verified acceptance criteria." | codemix task completecodemix task fail <id> --reason <reason>Fail a task.
Options:
--reason <reason> required failure reasoncodemix task log [id]Show task event timeline. If id is omitted, uses your currently claimed running task.
For deterministic automation:
--non-interactive.--json for machine parsing.--api-key or CODEMIX_API_KEY.--project or CODEMIX_PROJECT.Example agent loop:
codemix --non-interactive task next --wait | your-agent-commandClaim, work, and complete with summary:
codemix --non-interactive task next --no-prompt
# ...do work...
echo "Implemented change and ran tests" | codemix --non-interactive task completeFail with explicit reason:
codemix --non-interactive task fail <task-id> --reason "Blocked by missing API endpoint"codemix init creates codemix.jsonc in your working directory and ensures .codemix/ is ignored in .gitignore:
{
// JSON Schema for editor IntelliSense and validation
"$schema": "https://unpkg.com/codemix/codemix.schema.json",
// Project identifier in organization/project format
"project": "acme/todoapp",
// Optional Codemix API base URL override
"apiUrl": "https://codemix.com",
}Resolution order:
--api-url -> CODEMIX_API_URL/CODEMIX_BASE_URL -> codemix.jsonc apiUrl -> https://codemix.com--project -> CODEMIX_PROJECT -> codemix.jsonc project--api-key -> CODEMIX_API_KEY -> stored credential from codemix loginCODEMIX_API_KEYCODEMIX_PROJECTCODEMIX_API_URLCODEMIX_BASE_URL (alias for API URL)0 success1 usage error2 authentication error3 not found4 permission denied5 network or unknown runtime errornpm run typecheck
npm run test
npm run pack:check
npm publish --access publicpack:check runs npm pack --dry-run so you can verify the published tarball includes README.md, LICENSE, dist/index.js, codemix.schema.json, SKILL.md, and package.json.
Estimated unpacked size across 22 packages.
1.8 MB
Includes dependencies.
5 direct · 3 outdated
^5.6.2
6.0.1
^0.0.16
0.0.16
^0.8.2
0.8.3
^14.0.2
15.1.0
^7.10.1
8.8.0