Getting Started#

This page takes you through five minutes of setup: install, connect an LLM provider, open the interfaces, send your first message, and install your first ready-made agent program.

Step 1: Install#

Install the complete release runtime with its managed Python on macOS or Linux:

curl -fsSL https://openprogram.io/install | sh

On Windows x86_64, use PowerShell:

irm https://openprogram.io/install.ps1 | iex

The installer supplies its own Python and includes the Web UI, so Node.js is not a runtime requirement. Git is required for session and Memory history; openprogram doctor reports whether it is available. macOS Desktop uses the release DMG. Windows Desktop uses a signed win-x64.exe only when it is attached to that published release; otherwise use the complete Windows CLI/server runtime and browser UI. Windows sandbox execution is separate. Platform scope and development-checkout instructions are in Install.

Step 2: First run — connect a provider#

openprogram

The first run enters a setup wizard that walks you through provider configuration — import credentials from a logged-in Claude Code / Codex / Gemini CLI, or paste an API key — then drops you straight into the terminal chat. Re-run the wizard any time with openprogram setup.

If a provider key is already in your environment, import it into OpenProgram's credential store instead of pasting it into the wizard:

export OPENAI_API_KEY=sk-...
openprogram providers discover
openprogram providers adopt env:OPENAI_API_KEY

Repeat the last command with the matching env:<VARIABLE> source id for another provider. Alternatively, pipe a key directly to openprogram providers login <provider> --api-key-stdin. Sanity check: openprogram providers lists the stored credentials.

Step 3: Open the web UI#

openprogram web

This starts the background worker and opens your browser at http://localhost:18100 — a single port serving the web UI, the API, and the WebSocket. Change it with openprogram ports --port <p>.

Step 4: Send your first message#

Type directly into the terminal chat or the web input box. To quickly verify from the command line:

openprogram --print "Introduce yourself in one sentence"

It sends one message, prints the reply, and exits. Resume an earlier session with openprogram --resume <session_id> — ids come from openprogram sessions list or the web sidebar.

Step 5: Use the included agent programs#

Every release includes the GUI, Research, and Wiki Programs. They appear in the Web UI and function list without a separate installation step. Use openprogram programs available to inspect their registration status.

The Program installer is reserved for third-party Programs and developer source overlays. It does not define a reduced or expanded end-user edition.

Next steps#

• Models & providers — how each provider connects, multi-account, key rotation
• Agentic Programming — write your own Agent method
• Interfaces — terminal TUI, web UI, and channels
• Daily use — session management, branching, and rollback