ekkOS_docs
CLI Reference

ekkOS CLI Commands

Public command reference for @ekkos/cli. This page lists user-available commands and options only.

Install

npm install -g @ekkos/cli@latest

Quick Start

npm install -g @ekkos/cli@latest
ekkos init
ekkos pulse

Use ekkos <command> --help for command-level help.

Core Commands

Setup, launch, diagnostics, and top-level CLI operations.

ekkos

Default command (equivalent to `ekkos run`). See `ekkos pulse` for the recommended launch mode.

ekkos init

Initialize ekkOS and configure your IDE.

Options

  • -i, --ide <ide>
  • -k, --key <key>
  • -f, --force
  • -q, --quick
  • --skip-hooks (deprecated no-op)
  • --skip-skills
ekkos run

Launch Claude Code with ekkOS. Use `ekkos pulse` instead for the recommended experience.

Options

  • -s, --session <name>
  • -b, --bypass
  • --model [model]
  • --context-window <window>
  • --continue-last
  • --resume-session <id>
  • -v, --verbose
  • -d, --doctor
  • -r, --research
  • --skip-inject
  • --skip-proxy
  • --dashboard
  • --add-dir <dirs...>
ekkos pulse

Launch Pulse mode — the recommended way to start ekkOS.

Replaces `ekkos run --dashboard` as the default launch command.

Options

  • -s, --session <name>
  • --context-window <window>
  • --continue-last
  • --resume-session <id>
  • -v, --verbose
  • --skip-inject
  • --skip-proxy
  • --add-dir <dirs...>
ekkos cursor

Launch Cursor Agent CLI with ekkOS integration.

Options

  • -s, --session <name>
  • -m, --model <model>
  • --mode <mode>
  • --plan
  • --cloud
  • -p, --print
  • --output-format <format>
  • --yolo
  • --sandbox <mode>
  • --dashboard
  • --continue
  • --resume [chatId]
  • --setup-only
  • -v, --verbose
  • -w, --worktree [name]
  • --worktree-base <branch>
  • --proxy
ekkos ai

Launch AI assistant mode.

Options

  • -s, --session <name>
  • -v, --verbose
  • --skip-proxy
  • --dashboard
ekkos codex

Launch Codex mode.

Forwards to Synk command runner.

ekkos acp

Launch a generic ACP-compatible agent.

Forwards to Synk command runner.

ekkos mcp

Start the ekkOS Memory MCP stdio server.

ekkos scan

Scan repo structure and seed ekkOS registry.

Options

  • -c, --compile
  • -n, --dry-run
  • -p, --path <path>
ekkos status

Show live status and memory metrics.

Options

  • -w, --watch
  • --json
ekkos doctor

Check prerequisites and diagnose setup issues.

Options

  • -f, --fix
  • -j, --json
ekkos test

Test connection to ekkOS memory services.

ekkos test-claude

Launch Claude Code in test mode.

Options

  • --no-proxy
  • --no-hooks
  • -v, --verbose
ekkos logout

Clear local ekkOS credentials.

Options

  • -a, --all
ekkos hooksdeprecated

Deprecated compatibility command.

Monitoring & Usage

Session visibility, dashboard, and token/cost reporting.

ekkos dashboard [session-name]

Open live terminal dashboard.

Options

  • --latest
  • --wait-for-new
  • --refresh <ms>
  • --compact
  • --provider <name>
ekkos sessions

List active local sessions.

Options

  • -j, --json
ekkos usage

Usage summary (defaults to usage dashboard).

Options

  • -j, --json
ekkos usage daily

Daily usage breakdown.

Options

  • -d, --days <n>
  • -j, --json
ekkos usage weekly

Weekly usage breakdown.

Options

  • -w, --weeks <n>
  • -j, --json
ekkos usage monthly

Monthly usage breakdown.

Options

  • -j, --json
ekkos usage blocks

5-hour billing block analysis.

Options

  • -j, --json
ekkos usage session [session-id]

Session usage detail or session list.

Options

  • -l, --list
  • -i, --instance <id>
  • -j, --json
ekkos usage dashboard

Composite usage dashboard output.

Options

  • -j, --json
ekkos stream

Stream capture management command group.

ekkos stream status

Show stream capture status for a session.

Options

  • -s, --session <id>
  • -w, --watch
  • -j, --json
ekkos stream list

List sessions with stream data.

Docs / Cortex

Manage local `ekkOS_CONTEXT.md` generation and validation.

ekkos docs

Cortex command group.

Alias: `ekkos cortex`.

ekkos docs init

Initialize local Cortex docs for a repository.

Alias: `ekkos cortex init`.

Options

  • -p, --path <path>
  • --timezone <iana-tz>
  • --no-seed
ekkos docs watch

Watch workspace and keep docs updated.

Alias: `ekkos cortex watch`.

Options

  • -p, --path <path>
  • --timezone <iana-tz>
  • --poll-interval-ms <ms>
  • --debounce-ms <ms>
  • --no-seed
  • --rich
  • --no-rich
ekkos docs workspaces

Manage watched workspaces.

Alias: `ekkos cortex workspaces`.

Options

  • -l, --list
  • -a, --add <path>
  • -r, --remove <path>
ekkos docs setup-ci

Generate CI workflow for docs validation.

Alias: `ekkos cortex setup-ci`.

Options

  • -p, --path <path>
ekkos docs validate

Validate Cortex docs in a repo.

Alias: `ekkos cortex validate`.

Options

  • -p, --path <path>
  • --fix
  • --system <system_id>

OpenClaw Commands

OpenClaw integration commands exposed by ekkOS CLI.

ekkos claw

OpenClaw command group.

ekkos claw status

Show OpenClaw + ekkOS integration status.

Options

  • -j, --json
  • --proxy-url <url>
  • --model <model>
  • --workspace <path>
ekkos claw upgrade

Apply OpenClaw integration upgrades.

Options

  • --apply
  • --force
  • -j, --json
  • --proxy-url <url>
  • --model <model>
  • --workspace <path>

Synk Commands

Mobile sync/auth/vendor key commands available via `ekkos` wrappers.

ekkos auth

Authentication command group.

ekkos auth login

Authenticate with Synk.

Options

  • --web
ekkos auth logout

Clear Synk auth and machine data.

ekkos auth status

Show Synk auth status.

ekkos connect

Vendor key connection command group.

ekkos connect ekkos | codex | claude | ai

Connect vendor credentials.

ekkos connect status

Show connected vendor status.

ekkos sandbox

Sandbox command group.

ekkos sandbox configure

Interactive sandbox configuration.

ekkos sandbox status

Show current sandbox config state.

ekkos sandbox disable

Disable sandboxing.

ekkos daemon

Daemon command group.

ekkos daemon start | stop | status | list | logs | install | uninstall

Manage background Synk daemon.

ekkos daemon stop-session <session-id>

Stop a daemon-managed session.

ekkos notify

Send push notifications command.

ekkos notify -p <message> [-t <title>]

Send push notification to linked devices.

Headless Agent Commands

Remote agent controls under `ekkos agent ...`.

ekkos agent

Headless agent command group.

ekkos agent auth login | logout | status

Manage agent authentication state.

ekkos agent list

List sessions.

Options

  • --active
  • --json
ekkos agent status <session-id>

Get live session state.

Options

  • --json
ekkos agent create --tag <tag>

Create a new remote session.

Options

  • --path <path>
  • --json
ekkos agent send <session-id> <message>

Send a message to a session.

Options

  • --wait
  • --json
ekkos agent history <session-id>

Read session message history.

Options

  • --limit <n>
  • --json
ekkos agent stop <session-id>

Stop a remote session.

ekkos agent wait <session-id>

Wait until a remote session is idle.

Options

  • --timeout <seconds>

Compatibility Note

Command surface verified from local CLI sources for @ekkos/cli v1.6.3. If you upgrade versions, re-check with ekkos --help.