Skip to main content

OpenBase Coder CLI with embedded server

Project description

Openbase Coder

Openbase Coder is a local voice-coding runtime for working with AI coding agents from your Mac, browser, and Openbase clients.

The openbase-coder command installs and runs the local services that power Openbase Coder: a Django API, WebSocket endpoints, Codex/Super Agents coordination, local project and diff APIs, LiveKit voice services, plugin management, and the bundled web console.

This repository is the main open-source entrypoint for the Openbase Coder runtime.

What It Provides

  • Local API and WebSocket server for coding sessions, diffs, approvals, reports, project metadata, and service status
  • Local per-machine thread favorite metadata exposed on thread list/detail APIs
  • Voice-agent runtime built around LiveKit and Codex app-server sessions
  • One-command macOS/Linux setup for the Openbase workspace, environment file, console build, background services, and default agent instructions
  • Plugin installation and bootstrap commands for extending the local runtime
  • Openbase Cloud login support for authenticated client workflows
  • A local web console served by the CLI

Requirements

  • macOS (launchd) or Linux (systemd user services) for setup and service management; screen sharing and computer use are macOS-only
  • Python 3.13+
  • Git
  • uv for the recommended install/setup flow and local development
  • Node package tooling for the bundled console build
  • livekit-server on PATH for voice services

Quick Start

Recommended one-line setup with uvx:

uvx --python 3.13 openbase-coder setup

This runs the latest published openbase-coder package in an isolated uv tool environment and starts the normal first-time setup flow.

For a persistent command on your PATH after setup, install with uv tool:

uv tool install --python 3.13 openbase-coder
openbase-coder setup

pipx is also supported when you already manage Python tools that way:

pipx install --python python3.13 openbase-coder

Verify a persistent install:

openbase-coder --version

First-Time Setup

If you already installed the persistent openbase-coder command, run:

openbase-coder setup

Setup clones the public Openbase Coder workspace into ~/.openbase/workspace, syncs the runtime install set, generates ~/.openbase/.env if needed, builds the web console, installs launchd services, and prepares the local Codex home used by voice sessions.

After setup, check the local runtime:

uvx --python 3.13 openbase-coder doctor
uvx --python 3.13 openbase-coder services status

Run The Server

For foreground development:

uvx --python 3.13 openbase-coder server --host 0.0.0.0 --port 7999

For normal macOS background operation:

uvx --python 3.13 openbase-coder services start
uvx --python 3.13 openbase-coder services status

Common Commands

uvx --python 3.13 openbase-coder setup
uvx --python 3.13 openbase-coder doctor
uvx --python 3.13 openbase-coder login
uvx --python 3.13 openbase-coder services status
uvx --python 3.13 openbase-coder services logs django-cli
uvx --python 3.13 openbase-coder plugins list
uvx --python 3.13 openbase-coder bootstrap --help

If you installed with uv tool, omit uvx --python 3.13 from those commands.

Documentation

Development

From this repository:

uv sync --extra dev
uv run openbase-coder --version
uv run pytest

The CLI is part of the larger Openbase Coder multi-workspace. The public setup flow only syncs the runtime install set required by end users.

License

Openbase Coder CLI is licensed under AGPL-3.0-only.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbase_coder-0.1.6.tar.gz (168.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openbase_coder-0.1.6-py3-none-any.whl (220.0 kB view details)

Uploaded Python 3

File details

Details for the file openbase_coder-0.1.6.tar.gz.

File metadata

  • Download URL: openbase_coder-0.1.6.tar.gz
  • Upload date:
  • Size: 168.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for openbase_coder-0.1.6.tar.gz
Algorithm Hash digest
SHA256 fccd0b6235044a61ed0cafd8a503c39dd5f83ed69a221328fee51b4e5eec9163
MD5 926614b617c06737d63271230713bae1
BLAKE2b-256 e1087f20f124cc31668911c6c2eb9739778992cd2cf1e6a9b5db06203f9b1914

See more details on using hashes here.

File details

Details for the file openbase_coder-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: openbase_coder-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 220.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for openbase_coder-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fd8aa351cc020a6059b0dda07691df107bb8bdede3155d70532919ecc4d469d3
MD5 3270e11a9068b455ec83d29f6feb5512
BLAKE2b-256 6bc92714523a81d6aad0b089196051b90b775f1d3a0f913921bbb6e2be8e29a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page