Run Gideon yourself

Last reviewed

Self-hosting is an optional path for people who want to operate Gideon on their own machine. Hosted customers can skip this page: their models and runtime are managed.

Requirements

Use Python 3.12 or newer and macOS or Linux. Building the console from source also requires Node.js 22.12 or newer and npm. On Windows, use the container path described in the project’s guide. You need a model provider for model-backed work.

Run from a checkout

From your Gideon source checkout:

python3 -m venv .venv
.venv/bin/python -m pip install -e .
npm ci
npm run build
export GIDEON_HOME="$PWD/.dev-home"
.venv/bin/gideon setup
.venv/bin/gideon gateway --no-open --port 10000

Open the console address printed by the gateway. Setup asks for your workspace and timezone. The isolated .dev-home directory keeps this instance separate from an existing personal installation.

Configure a provider

Open Apps, install the provider app you intend to use, and configure it under Settings → Providers. Test connectivity, then bind a chat model under Settings → Models. A hosted account does not expose these provider controls.

Maintain your installation

gideon doctor diagnoses missing dependencies and model setup. gideon token produces a fresh dashboard access URL. Keep that URL private. gideon snapshot creates a state archive; read the restore instructions before using gideon restore.

The project is pre-1.0. Review release notes before updates. A package or image must actually be available before choosing that distribution path; this guide does not assume a published release.

For platform-specific details, see the source installation guide and container guide.

Ask Learn Gideon

Answers from the documentation.

What would you like to know?

Ask a question, find a guide, or get help with your next step.

Enter to send · Shift+Enter for a new line