Documentation
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.

This reference tracks ox 0.25.0. Run ox version to check yours and ox upgrade to update. See ox release-notes for what changed.

Installation

terminal
$

Or install with Homebrew:

terminal
$
$

After installation, verify it works:

terminal
$

Quick setup

terminal
# Authenticate with SageOx
$
# Initialize your repository
$
# Verify everything works
$

Command reference

Grouped as they appear in ox --help.

Software development

CommandDescription
ox codeSearch code, symbols, history, PRs, and comments in this repo
ox decisionWork with Decision Records (ADRs, DDRs), enriched with Team Context
ox indexIndex code and project data for search
ox initInitialize SageOx for this repository
ox planWork with plans (enrich, render, review)
ox prAuthor SageOx content for pull requests
ox sessionManage AI coworker sessions
ox vizChoose, author, render, and lint visual explanations

Knowledge

CommandDescription
ox briefShow what SageOx gave this session
ox conversationRead recorded team conversations from the local Team Context
ox importImport a document, media file, or video URL into Team Context
ox kbWork with Knowledge Bubbles
ox querySearch team knowledge
ox recapShow the concrete value SageOx has delivered to your work
ox skillsInspect the skills your AI coworkers have

Teams

CommandDescription
ox bulletinPost to the team bulletin board (team Feature Preview)
ox exportShow where your data lives and how to take it with you
ox glanceSee what your team's AI coworkers are working on
ox murmurPublish a coordination signal to other AI coworkers
ox teamWork with your teams and coworkers

Authentication

CommandDescription
ox loginAuthenticate with sageox.ai
ox logoutLog out of SageOx
ox statusDisplay SageOx status and directory locations
ox syncManually sync ledger/team contexts (rarely needed)

Agent integration

CommandDescription
ox agentUX exposed to AI coding agents (not for human use)
ox agent primeInject Team Context into an AI coworker session
ox coworkerManage expert agents and subagents for your team
ox hooksManage event hooks for daemon notifications
ox integrateSet up SageOx integration with Claude Code

Diagnostics

CommandDescription
ox adapterManage external adapter binaries
ox daemonManage the background sync daemon
ox doctorRun diagnostics on ox installation and configuration
ox feedbackSend private product feedback to SageOx Support
ox gcReclone eligible managed repositories safely
ox guideShow a bundled topical guide
ox release-notesDisplay release notes for the current version
ox upgradeUpgrade ox to the latest or a specific version
ox versionPrint version information

Additional commands

CommandDescription
ox addonsInstall skills, rules, and the context each skill carries
ox configManage ox configuration
ox petShow Oxy, SageOx's mascot, in Claude Code and Codex
ox uninstallRemove SageOx from this repository
ox viewOpen the SageOx dashboard in your browser
ox walkthroughShow what was on screen, clicked, and pointed at in a walkthrough

Global flags

These flags work with any command:

FlagDescription
-v, --verboseShow detailed output
-q, --quietSuppress non-error output
--jsonOutput in JSON format (for scripting)
-c, --config <path>User config file (overrides OX_USER_CONFIG)
--no-inputDisable prompts and terminal UI; provide required input with arguments or flags
--no-interactiveDisable spinners and TUI elements (auto-enabled when CI=true)
--yesAnswer yes to confirmation prompts without reading stdin (overrides a piped answer)
--profileGenerate a CPU profile and execution trace for performance analysis

Configuration

ox stores configuration in two locations:

LocationPurpose
~/.config/sageox/Global config and credentials
.sageox/config.jsonRepository-specific settings

What's next