Command Reference

Portable installation, lifecycle, configuration, authentication, and maintenance commands.

This page is the compact syntax reference. For task-oriented explanations and data-safety guidance, start with Use the Oblive CLI.

Installation

curl -fsSL https://oblive.dev/install.sh | sh
curl -fsSL https://oblive.dev/install.sh | sh -s -- --version v1.2.3
curl -fsSL https://oblive.dev/install.sh | sh -s -- --no-start

Use curl -fsSL https://oblive.dev/install.sh | sh -s -- --help for every bootstrap option.

Multiple Instances

curl -fsSL https://oblive.dev/install.sh | sh -s -- --instance preview --port-base 10000
oblive instances
oblive --instance preview start --no-open
oblive --instance preview status
oblive --instance preview update
oblive --instance preview stop

Place --instance <name> before any command. Commands without it select default. Each instance has independent data and a pinned release. New named installations require a range of six unused ports; the frontend uses --port-base + 5. See installation.

Help and Output

oblive
oblive --help
oblive help logs
oblive logs --help
oblive --version

Running oblive without arguments shows the command overview. Help and successful commands exit with status 0, invalid commands or arguments exit with status 2, and runtime failures exit with status 1. Color is limited to semantic headings and statuses, appears only in a terminal, and can be disabled with NO_COLOR=1.

Health and Lifecycle

oblive doctor
oblive start [--no-open]
oblive stop
oblive restart [--no-open]
oblive status

Logs

oblive logs
oblive logs [--follow] [service]

Valid services are postgres, redis, garage, migrate, backend, frontend, agent-chat, agent-worker, and codex-auth-sync.

Configuration and Authentication

oblive config path
oblive config edit
oblive config check
oblive auth status
oblive auth login

The config command manages the human-owned deployment configuration. auth login applies to local Codex mode. API-key mode reads the configured host environment variable at runtime, keeps it out of local-stack.json, and writes it only to mode-0600 generated agent environment files for Compose.

Versions and Updates

oblive version
oblive update
oblive update --latest
oblive update --version v1.3.0

start never updates. Plain update advances only the latest channel; pinned installations need an explicit target. Downgrades are rejected.

Destructive Commands

oblive reset --confirm
oblive uninstall
oblive uninstall --purge --confirm

Plain uninstall retains configuration and data volumes. Reset and purge remove data.

Human CLI vs Agent CLI

oblive is the host operator CLI documented above. oblivectl is a different, authenticated control-plane CLI available only inside an authorized agent run. Humans should not use oblivectl to manage the Docker deployment.

Inside an authorized agent run, these read-only commands show the safe integration inventory:

oblivectl integration list
oblivectl integration show apollo

Contributor Commands

Source development still uses Bun and the repository launcher:

bun install --frozen-lockfile
bun run stack env
bun run stack config
bun run stack up
bun run check:all
bun test

See the Repository Guide before using the source workflow.

Default Endpoints

Surface	Default URL
Backend health	`http://127.0.0.1:3000/health`
Backend API explorer	`http://127.0.0.1:3000/docs`
Backend OpenAPI JSON	`http://127.0.0.1:3000/docs/spec.json`
Product	`http://127.0.0.1:3001`

Live integration context

contextctl integration list and contextctl integration show <key> read the current safe registry, including contextRevision and operatingContext. Credentials are never returned. contextctl integration update <key> --from-json - (also available through oblivectl) accepts:

{
  "expectedRevision": 0,
  "context": {
    "organizationPurpose": "Source code hosting",
    "departments": ["engineering"],
    "resources": [
      {
        "kind": "repository",
        "externalId": "org/product",
        "name": "Product",
        "url": "https://github.com/org/product",
        "defaultBranch": "main",
        "departments": ["engineering"]
      }
    ]
  }
}

An update replaces the whole operating context. Read first and preserve fields you intend to keep. A stale revision returns 409; read the new context and reconcile before retrying. Only current Chat and Operator executions may save organization integration context. Saving does not start an agentic refresh. Connection and permission changes invalidate access independently of semantic Context.

On this page