Install Oblive
Install a coordinated semantic release and start the complete local stack.
Quick Install
Run the installer on macOS or Linux:
curl -fsSL https://oblive.dev/install.sh | shThe interactive flow checks the host, offers missing prerequisites, verifies Codex login, downloads
and verifies the release checksum and deployment bundle, creates a secure configuration, and starts
every service. It also offers to add the oblive command to your PATH; pressing Enter accepts this
recommended default.
To review the installer before running it:
curl -fsSL https://oblive.dev/install.sh -o /tmp/oblive-install.sh
less /tmp/oblive-install.sh
sh /tmp/oblive-install.shLatest or a Selected Version
The default latest channel resolves the current stable version from downloads.oblive.dev during
installation. Oblive then records and runs that exact semantic version across the backend,
frontend, agents, and deployment bundle. Starting the stack never changes the installed version.
Pin a selected stable version with:
curl -fsSL https://oblive.dev/install.sh | sh -s -- --version v1.2.3Both 1.2.3 and v1.2.3 are accepted. Pre-release versions are rejected.
Authentication
The default local mode uses your Codex CLI login. For API-key mode, provide the configured host
environment variable while installing and whenever Oblive starts or checks authentication:
export OPENAI_API_KEY="your-key"
curl -fsSL https://oblive.dev/install.sh | sh -s -- --auth api-keyThe installer does not write the key to local-stack.json or release metadata. During startup, the
typed stack generator writes it only to the mode-0600 agent environment files under .runtime/
for Docker Compose. Keep the installation directory private. Use oblive auth status to verify
that the configured variable is available; oblive auth login is only for local Codex mode.
Installer Options
| Option | Effect |
|---|---|
--channel latest | Follow stable releases when oblive update runs |
--version vX.Y.Z | Install and pin one stable semantic version |
--install-dir path | Override the default ~/.oblive installation directory |
--auth local|api-key | Select Codex login or host API-key authentication |
--no-start | Install and create configuration without starting services |
--add-to-path | Add ~/.local/bin to the detected shell profile without asking |
--no-add-to-path | Leave shell profiles unchanged |
--install-prerequisites | Approve offering the supported prerequisite installers |
--yes | Accept installer prompts for unattended, already-reviewed use |
For example, install without starting or editing a shell profile:
curl -fsSL https://oblive.dev/install.sh | \
sh -s -- --channel latest --no-start --no-add-to-pathThe installer updates .zshrc, .bash_profile on macOS Bash, .bashrc on Linux Bash,
.config/fish/config.fish for Fish, or .profile as a portable fallback. Existing entries are not
duplicated, and no profile is changed when the binary directory is already on PATH. When the
current shell still needs refreshing, the installer prints the exact command to run.
Generated Files
The default installation creates:
~/.local/bin/oblive— the human operator CLI;~/.oblive/local-stack.json— your mode-0600configuration and generated secrets;~/.oblive/local-stack.schema.json— editor completion and validation help;~/.oblive/.runtime/— generated Compose environment files; and- release-pinned Compose files and metadata under
~/.oblive.
Edit only local-stack.json; generated environment files are outputs. The installer preserves an
existing configuration during reinstall and update.
oblive config path
oblive config edit
oblive config checkFirst Start
If you used --no-start, start later with:
oblive startStartup waits for PostgreSQL, Redis, and Garage, runs migrations once, then starts the backend,
frontend, chat runtime, and configured worker replicas. The browser opens only after the stack is
ready; use oblive start --no-open to suppress it.
In-place downgrades are rejected because an applied database migration may be irreversible. Restore from an appropriate backup instead of replacing release files with an older bundle.
Developing from Source
The portable installation needs no repository checkout. Contributors should use the separate Repository Guide and Local Stack and Migrations workflow.
Next
Learn everyday operations in Use the Oblive CLI. Then Verify and Maintain before you Onboard Your Business.