omnidotdev-cli 0.2.1

docs.rs failed to build omnidotdev-cli-0.2.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Website | Docs | Provide feedback on Omni Backfeed | Join Omni community on Discord

Omni CLI is an agentic CLI for the Omni ecosystem. It provides three interfaces:

CLI: Traditional command-line interface for scripting and automation
TUI: Interactive terminal user interface for visual workflows
HTTP API: RESTful API for remote access and integrations

Installation

cargo install omnidotdev-cli

Or build from source:

git clone https://github.com/omnidotdev/cli
cd cli
cargo build --release
# Binary will be at target/release/omni

Quick Start

TUI Mode (Default)

omni

CLI Mode

omni agent "summarize the README in this directory"

HTTP API Mode

omni serve --host 0.0.0.0 --port 7890

Configuration

omni config path    # Show config file location
omni config show    # Display current config

Configuration file (~/.config/omni/cli/config.toml):

[agent]
provider = "anthropic"
model = "claude-sonnet-4-20250514"
max_tokens = 8192

[api]
host = "0.0.0.0"
port = 7890
token = "omni_..."  # Generate with: omni config generate-token

HTTP API

Endpoints

Method	Path	Description
`GET`	`/health`	Health check (public)
`POST`	`/api/agent`	Execute an agentic task
`POST`	`/api/agent/stream`	Execute with SSE streaming
`GET`	`/api/history`	Get task execution history
`GET`	`/api/docs`	Swagger UI documentation

Authentication

For remote access, generate and configure an API token:

omni config generate-token

Then set it in your config or environment:

export OMNI_API_TOKEN="omni_..."

Requests require the Authorization: Bearer <token> header:

curl -X POST http://localhost:7890/api/agent \
  -H "Authorization: Bearer omni_..." \
  -H "Content-Type: application/json" \
  -d '{"prompt": "What is 2+2?"}'

Development

Version Syncing

Omni CLI uses a dual-package setup (Rust crate + npm package) with automated version synchronization:

Source of truth: package.json holds the canonical version, and is used for Changesets
Sync script: scripts/syncVersion.ts propagates the version to Cargo.toml
Changesets: Manages version bumps and changelog generation

The sync script runs automatically during the release process via the version npm script:

bun run version  # syncs `package.json` version → `Cargo.toml`

CI/CD

Two GitHub workflows handle versioning:

Workflow	Trigger	Purpose
`test.yml`	Push/PR to `master`	Runs tests and builds
`release.yml`	Push to `master`	Creates releases via Changesets, builds multi-platform binaries

Release Process

Create a changeset: bun changeset
Push to master
Changesets action creates a "Version Packages" PR
Merge the PR to trigger a release with binaries for:
- x86_64-unknown-linux-gnu
- aarch64-unknown-linux-gnu
- x86_64-apple-darwin
- aarch64-apple-darwin
Manually publish to crates.io: cargo publish