Oblive Docs
Getting Started

Verify and Maintain

Check health, inspect logs, update deliberately, and remove data only with confirmation.

Check the Installation

oblive doctor
oblive status

doctor validates Docker, Compose, release metadata, the typed configuration, and the selected authentication source. status shows infrastructure, migration, backend, frontend, chat, and worker containers. A completed migration container is expected.

The default endpoints are:

  • product: http://127.0.0.1:3001;
  • backend health: http://127.0.0.1:3000/health;
  • API explorer: http://127.0.0.1:3000/docs; and
  • OpenAPI JSON: http://127.0.0.1:3000/docs/spec.json.

Read Logs

oblive logs
oblive logs --follow
oblive logs backend
oblive logs --follow agent-worker

Service names are allowlisted: postgres, redis, garage, migrate, backend, frontend, agent-chat, agent-worker, and codex-auth-sync.

Stop and Restart

oblive stop
oblive start
oblive restart --no-open

Normal stop/start preserves named volumes. start uses the currently installed semantic version and never checks for an update.

Update Deliberately

oblive version
oblive update

For a latest installation, oblive update resolves the current stable release, validates it, preflights the new configuration, and updates all first-party services together. A pinned installation remains pinned and tells you which explicit command to use:

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

If the stack was running, update restarts it. If it was stopped, it remains stopped. A failed start after migrations does not automatically install an older release.

Authentication

oblive auth status
oblive auth login

login applies to local Codex mode. In API-key mode, status checks the configured host environment variable.

Reset or Uninstall

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

reset removes containers and all named data volumes. Plain uninstall stops the stack and removes the CLI link while retaining configuration and volumes. --purge --confirm removes the installation, configuration, containers, and volumes.

Reset and purge are destructive. Export anything you need before confirming either operation.

Troubleshooting Order

  1. Run oblive doctor.
  2. Run oblive config check.
  3. Run oblive status to find the first failing dependency.
  4. Read that service’s logs.
  5. Check port conflicts and authentication inputs.
  6. Reset only when losing local data is acceptable and state corruption is the actual problem.

For symptom-based help, see Troubleshooting.