generated: '2026-08-27'
method: searched
source: >-
  https://docs.simetrik.com/cli, https://docs.simetrik.com/cli/reference,
  https://docs.simetrik.com/cli/getting-started/installation, the docs llms.txt map, the published
  installer at https://cli.simetrik.com, and the release manifest at
  https://cli.simetrik.com/cli/manifest.json, 2026-08-27.
name: Simetrik CLI
binary: simetrik
version: 1.3.8
released: '2026-08-27'
description: >-
  A first-party, cross-platform CLI that operates a Simetrik workspace from the terminal. Simetrik
  positions it as the agent-facing surface as much as the human one: the docs headline is "Talk to your
  AI agent to run Simetrik", and the installer ships a Claude Agent Skill alongside the binary. It is
  the only self-service programmatic write path Simetrik publishes - the platform ships no public REST
  API, and the MCP server routes all writes through a single agent tool.
install:
- platform: macos-linux
  command: curl -fsSL https://cli.simetrik.com | sh
- platform: windows
  command: irm https://cli.simetrik.com/install.ps1 | iex
- platform: any
  command: curl -fsSL https://cli.simetrik.com | sh -s -- --version 1.3.8 --install-dir /usr/local/bin
  note: Pin a specific version and install directory.
install_env_vars:
- SIMETRIK_CDN_BASE
- SIMETRIK_INSTALL_DIR
- SIMETRIK_VERSION
- SIMETRIK_CHANNEL
integrity: >-
  The installer fetches channels.<channel>.latest_version from the release manifest, downloads the
  matching per-platform archive, and verifies its published sha256 before extracting. It does the same
  for the optional Claude skill bundle and warns-and-continues rather than failing the CLI install if
  the skill fails.
auth:
  command: simetrik login
  model: Browser-based OAuth via Auth0, exchanged for a BFF session token stored in the local profile.
  device_flow: true
  device_flow_note: >-
    `simetrik login --device` uses the device authorization flow with no browser - documented
    explicitly for SSH, CI and agents.
  logout: simetrik logout revokes the BFF token and clears it from the local profile.
  prerequisites:
  - The workspace must be gated on for CLI access.
  - The user's role must carry the "Use CLI" permission (granted in app.simetrik.com).
  ttl_flags: [--ttl (CLI session lifetime in hours), --access-token-ttl (access token lifetime in seconds)]
  profiles: >-
    Named connection profiles hold an environment preset (--env) or a custom BFF base URL (--url) plus
    an optional bearer token; switched with `simetrik config use-profile`. Passing both --env and --url
    is rejected with exit 2.
command_groups:
- group: Account & workspace
  commands: [login, logout, config, workspace, delete, cache clear]
- group: Sources & data
  commands: [describe, source, file, data query]
- group: Onboarding & devx
  commands: [doctor, update, version, skill, completion, open, samples, init]
- group: Scheduling & tasks
  commands: [schedule, task, alarm, approval]
- group: Reconciliation
  commands: [recon, ruleset]
- group: Advanced reconciliation
  commands: [adv-recon, vlookup]
- group: Accounting
  commands: [schema, accounting-automation, accounting-integrations, accounting-entry]
- group: Transforms
  commands: [union, join, group, column, massive-column, segment]
- group: Consolidation & balances
  commands: [consolidation, snapshot, opening-records, cumulative-balance create]
- group: Resources & templates
  commands: [resource, graph, template upload, folder]
- group: Exports & integrations
  commands: [integration, export]
- group: Declarative flows
  commands: [run]
- group: Operation Center
  commands: [dashboard, dataset]
- group: Observability
  commands: [notification listen, logs tail, monitor, incident]
- group: Smart rules
  commands: [suggest]
- group: Spec
  commands: [spec export]
notable_capabilities:
- capability: Machine-readable CLI spec
  command: simetrik spec export
  note: >-
    Exports the full CLI surface as a flat cli-spec JSON document to stdout or a file. This is the
    closest thing Simetrik publishes to a machine-readable contract, but it is emitted by the installed
    binary rather than served from a URL, so it cannot be harvested anonymously.
- capability: Declarative playbooks
  command: simetrik run <playbook.yml|json>
  note: Runs a declarative playbook file, chaining steps with inter-step references.
- capability: Real-time event stream
  command: simetrik notification listen
  note: >-
    Connects to the events sidecar and streams platform notifications over SSE; --output json emits
    NDJSON, one event per line. This is Simetrik's only published streaming/event surface.
- capability: Shell completion
  command: simetrik completion <bash|zsh|fish|pwsh>
- capability: Self-diagnosis
  command: simetrik doctor
  note: Diagnoses install, config, auth, network and shell; --fix auto-heals stale state.
- capability: Agent skill management
  command: simetrik skill install
  note: Fetches the published Claude Agent Skill bundle for the current channel.
output:
  formats: [table, json]
  convention: >-
    --format json (or the global -o json) on create commands; -y/--yes is required on destructive
    commands in non-interactive runs, because without a TTY the confirmation prompt reads EOF and
    cancels with exit 2.
exit_codes:
- code: 0
  meaning: Success
- code: 1
  meaning: BFF/API error - the server rejected the request
- code: 2
  meaning: Invalid input, or a confirmation prompt cancelled / read EOF without a TTY
- code: 4
  meaning: Authentication required - run simetrik login
limits_doc: https://docs.simetrik.com/cli/limits
troubleshooting_doc: https://docs.simetrik.com/cli/troubleshooting
docs: https://docs.simetrik.com/cli
reference: https://docs.simetrik.com/cli/reference