# ox CLI (https://sageox.ai/docs/cli)

# ox CLI

The ox CLI connects your repositories to the SageOx platform, giving your AI coworkers access to Team Context: your team's recorded discussions, decisions, and current work.

<Callout type="info">
  This reference tracks **ox 0.14.0**. Run `ox version` to check yours and `ox upgrade` to update. See [`ox release-notes`](/docs/cli/release-notes) for what changed.
</Callout>

## Installation

<Terminal>
  <TerminalCommand>curl -fsSL https://raw.githubusercontent.com/sageox/ox/main/scripts/install.sh | bash</TerminalCommand>
</Terminal>

After installation, verify it works:

<Terminal>
  <TerminalCommand>ox version</TerminalCommand>
</Terminal>

## Quick setup

<Terminal>
  <TerminalComment>Authenticate with SageOx</TerminalComment>
  <TerminalCommand>ox login</TerminalCommand>
  <TerminalComment>Initialize your repository</TerminalComment>
  <TerminalCommand>ox init</TerminalCommand>
  <TerminalComment>Verify everything works</TerminalComment>
  <TerminalCommand>ox doctor</TerminalCommand>
</Terminal>

## Command reference

Grouped as they appear in `ox --help`.

### Software development

| Command | Description |
|---------|-------------|
| [`ox code`](/docs/cli/code) | Search code in this repo |
| [`ox decision`](/docs/cli/decision) | Work with Decision Records (ADRs, DDRs) |
| [`ox index`](/docs/cli/index-cmd) | Index code and project data for search |
| [`ox init`](/docs/cli/init) | Initialize SageOx for this repository |
| [`ox plan`](/docs/cli/plan) | Work with implementation plans |
| [`ox pr`](/docs/cli/pr) | Author SageOx content for pull requests |
| [`ox session`](/docs/cli/session) | Manage AI coworker sessions |
| [`ox viz`](/docs/cli/viz) | Choose, author, render, and lint visual explanations |

### Knowledge

| Command | Description |
|---------|-------------|
| [`ox conversation`](/docs/cli/conversation) | Read recorded team conversations from the local Team Context |
| [`ox distill`](/docs/cli/distill) | Distill team observations into memory summaries |
| [`ox import`](/docs/cli/import) | Import a document, media file, or video URL into Team Context |
| [`ox kb`](/docs/cli/kb) | Work with Knowledge Bubbles |
| [`ox query`](/docs/cli/query) | Search team knowledge |
| [`ox recap`](/docs/cli/recap) | Show the concrete value SageOx has delivered to your work |

### Teams

| Command | Description |
|---------|-------------|
| [`ox export`](/docs/cli/export) | Show where your data lives and how to take it with you |
| [`ox glance`](/docs/cli/glance) | See what your team's AI coworkers are working on |
| [`ox murmur`](/docs/cli/murmur) | Publish a coordination signal to other AI coworkers |
| [`ox team`](/docs/cli/team) | Work with your teams and coworkers |

### Authentication

| Command | Description |
|---------|-------------|
| [`ox login`](/docs/cli/auth) | Authenticate with sageox.ai |
| [`ox logout`](/docs/cli/auth) | Log out of SageOx |
| [`ox status`](/docs/cli/status) | Display SageOx status and directory locations |
| [`ox sync`](/docs/cli/sync) | Manually sync ledger/team contexts (rarely needed) |

### Agent integration

| Command | Description |
|---------|-------------|
| [`ox agent`](/docs/cli/agent) | UX exposed to AI coding agents |
| [`ox agent prime`](/docs/cli/prime) | Inject Team Context into an AI coworker session |
| [`ox coworker`](/docs/cli/coworker) | Manage expert agents and subagents for your team |
| [`ox hooks`](/docs/cli/hooks) | Manage event hooks for daemon notifications |
| [`ox integrate`](/docs/cli/integrate) | Set up SageOx integration with Claude Code |

### Diagnostics

| Command | Description |
|---------|-------------|
| [`ox adapter`](/docs/cli/adapter) | Manage external adapter binaries |
| [`ox daemon`](/docs/cli/daemon) | Manage the background sync daemon |
| [`ox doctor`](/docs/cli/doctor) | Run diagnostics on ox installation and configuration |
| [`ox gc`](/docs/cli/gc) | Reclone eligible managed repositories safely |
| [`ox guide`](/docs/cli/guide) | Show a bundled topical guide |
| [`ox release-notes`](/docs/cli/release-notes) | Display release notes for the current version |
| [`ox upgrade`](/docs/cli/upgrade) | Upgrade ox to the latest version |
| [`ox version`](/docs/cli/version) | Print version information |

### Configuration and utilities

| Command | Description |
|---------|-------------|
| [`ox config`](/docs/cli/config) | Manage ox configuration |
| [`ox uninstall`](/docs/cli/uninstall) | Remove SageOx from this repository |
| [`ox view`](/docs/cli/view) | Open the SageOx dashboard in your browser |

## Global flags

These flags work with any command:

| Flag | Description |
|------|-------------|
| `-v, --verbose` | Show detailed output |
| `-q, --quiet` | Suppress non-error output |
| `--json` | Output in JSON format (for scripting) |
| `-c, --config <path>` | Config file path (default: `.sageox/config.yaml`) |
| `--no-interactive` | Disable spinners and TUI elements (auto-enabled when `CI=true`) |
| `--profile` | Generate a CPU profile and execution trace for performance analysis |

## Configuration

ox stores configuration in two locations:

| Location | Purpose |
|----------|---------|
| `~/.config/sageox/` | Global config and credentials |
| `.sageox/config.yaml` | Repository-specific settings |

## What's next

- [CLI quickstart](/docs/cli/quickstart) - Get started in minutes
- [ox init](/docs/cli/init) - Initialize your first repository
- [ox login](/docs/cli/auth) - Authentication details
- [ox doctor](/docs/cli/doctor) - Troubleshoot setup issues
- [ox agent prime](/docs/cli/prime) - How AI coworkers get Team Context