SIMY CLI
Local executor for SIMY. It runs SIMY Local Tasks and Delivery Loop work on your machine, supervises Codex and Claude Code conversations, runs SQM quality checks, and backs the SIMY desktop apps.
Install
Requires Node.js 20 or newer.
npm install -g @awak-app/simy-cli
simy --daemon --host "https://app.simy.one"
The daemon keeps itself up to date with verified stable releases
(simy update --check shows the current state, --no-auto-update disables it).
On Apple Silicon Macs the desktop app installs and updates the CLI; see
Apple Silicon Mac app.
Commands
| Command | Purpose |
|---|---|
simy | Start the local agent with the interactive console |
simy --daemon / simy --no-tui | Run in the background / in the foreground without the console |
simy doctor | Read-only diagnostics: versions, connection, provider sign-in and recent failures |
simy sessions | List local and registered remote Codex / Claude Code conversations |
simy delivery ... | Inspect and control Delivery Loop runs in provider conversations |
simy sqm min-check / simy sqm check | Fast SQM preflight / full SQM check with a signed proof.json |
simy connections | Guidance for connecting another computer |
simy mcp | Claude Desktop MCP stdio server |
simy update | Install an eligible stable CLI update |
Run simy --help for every option.
Documentation
- Architecture overview — entry points, feature areas and dependency rules
- Documentation index — architecture, behavior reference, desktop app, operations
- Changelog
Development
npm ci
npm test # unit and integration tests
npm run check # syntax checks, tests and package contents (what CI runs)
End-to-end scripts live in scripts/ and run with npm run test:e2e:<name>.
Repository layout:
| Path | Contents |
|---|---|
src/ | CLI, agent, desktop host and the shipped provider plugin (src/codex-plugins/simy/) |
test/ | node:test suites and their fixtures |
fixtures/ui-reference/ | Frozen native UI reference inputs and manual capture methods |
scripts/ | End-to-end runners, live probes and release helpers |
packaging/ | macOS and Windows desktop apps, installers and CI helpers |
docs/ | Documentation |
Conventions:
- Commit messages and PR titles start with
feat:,fix:,refactor:,chore:orinfra:. - Keep
src/codex-plugins/simy/standalone and respect the layering in hooks/delivery/README.md. - Remove code and tests that no runtime path uses instead of keeping them for reference; git history keeps them.
Releasing
- Bump
versioninpackage.jsonandpackage-lock.json, add aCHANGELOG.mdentry, and setCLI_VERSIONinsrc/cli-contract.js. - Merge the release PR into
dev. - Push the tag
v<version>on the merge commit..github/workflows/publish.ymlruns the checks and publishes to npm.
See publishing for trusted publishing and recovery.