Installation

Prerequisites

For the default platform path, you only need Docker.

• Docker Engine or a compatible container runtime

If you are building your own host or working from source, the repository currently targets .NET SDK 10.0.101 and net10.0.

• .NET SDK: 10.0.101+
• Node.js: 20+ only when you are building the web UI or working on the full server product

Default path: run the published image

Pull the server image:

docker pull ghcr.io/agent-circuits/agentcircuits-server:latest

Run it with file storage, local-user auth, and a provider key:

docker run -p 8080:8080 \
  -v ./data:/data \
  -e AGENTCIRCUITS__AUTH__PROVIDERS__0=LocalUserId \
  -e AGENTCIRCUITS__AUTH__LOCALUSERID__ENABLED=true \
  -e AGENTCIRCUITS__PORTAL__REQUIREAUTHENTICATION=true \
  -e AGENTCIRCUITS__PROVIDERS__ANTHROPIC__API_KEY=sk-ant-... \
  ghcr.io/agent-circuits/agentcircuits-server:latest

For a local SQL-backed runtime, the server repo also includes a docker-compose.yml profile that runs AgentCircuits against PostgreSQL.

Optional path: install packages

If you need your own host, install AgentCircuits.Server or go directly to the lower-level packages.

Start with the hosted runtime package plus a provider package:

dotnet add package AgentCircuits.Server
dotnet add package AgentCircuits.Providers.Anthropic

Lower-level packages remain available when you want to embed the runtime directly:

dotnet add package AgentCircuits.Core
dotnet add package AgentCircuits.Providers.Anthropic

Other provider packages:

dotnet add package AgentCircuits.Providers.OpenAI
dotnet add package AgentCircuits.Providers.Gemini
dotnet add package AgentCircuits.Providers.Bedrock
dotnet add package AgentCircuits.Providers.Ollama
dotnet add package AgentCircuits.Providers.Grok

Related platform packages:

dotnet add package AgentCircuits.Portal
dotnet add package AgentCircuits.UI
dotnet add package AgentCircuits.Storage.Sql
dotnet add package AgentCircuits.A2A
dotnet add package AgentCircuits.Channels

Correct package name

Use AgentCircuits.Core for the core runtime package.

Some older sample docs still mention AgentCircuits, but the current package ID in source is AgentCircuits.Core.

Provider credentials

Provider packages read their credentials from environment variables unless you pass options explicitly.

Common environment variables:

ANTHROPIC_API_KEY=...
OPENAI_API_KEY=...
GEMINI_API_KEY=...
XAI_API_KEY=...
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...

In the hosted runtime, built-in provider registration can read these environment variables directly. Programmatic configuration still has the highest priority when you build your own host.

Continue to Quick Start for the first working platform run.