Docs

From nothing to a first conversation.

What you need, the commands that start it on your machine, and where to go from there.

You needNode 24 or laterpnpm 10Docker

Quick start

Start it on your machine.

Five steps, in this order.

The same commands, together

pnpm install
pnpm setup                    # writes .env with fresh secrets
pnpm stack:up                 # Postgres, Valkey, object storage
pnpm db:migrate
pnpm --filter @agents/api dev
pnpm --filter @agents/runtime dev
pnpm dev:web                  # http://localhost:3300

1
Install the dependencies
bash
```
pnpm install
```
2
Write the environment file
It writes .env with fresh secrets.
bash
```
pnpm setup
```
3
Start the stack
Postgres, Valkey and object storage, in Docker.
bash
```
pnpm stack:up
```
4
Set up the database
bash
```
pnpm db:migrate
```
5
Start the services
The api, the runtime and the web app, each in a terminal of its own. Then open http://localhost:3300.
bash
```
pnpm --filter @agents/api dev
pnpm --filter @agents/runtime dev
pnpm dev:web
```

A first agent

Then make an agent, and talk to it.

With no cloud keys at all, if you run a model on your own machine.

Sign up, and create a workspace
Connect a model
Under Integrations. For a model on your own machine, install Ollama, pull a model that can call tools, and add it as provider Ollama.
Make an agent from a template
Publish it
Talk to it
In the builder’s test console.

A first call

For phone calls, start the gateway as well.

Then add a trunk under Telephony.

How to connect your PBX

Start the SIP gateway

docker compose --profile gateway up -d

On a server

One Ubuntu server, everything in Docker.

TLS by itself. One host script installs Docker, sets up the firewall, writes fresh secrets, builds the images and starts everything.

Requirements, ports and what runs

The host script, with its options

sudo /opt/sidekick-agents/infra/scripts/host/bootstrap-ubuntu.sh \
  --domain example.com --public-ip 203.0.113.10 \
  --admin-cidr 198.51.100.0/24 --pbx-cidr 192.0.2.10

Not yet exercised end to end

The runbook has been checked on a development machine. A call from a real PBX to a server set up by it has not been made. Treat the first installation as a rehearsal.

Read on

Where to go next.

The full documents ship with the product, in its docs folder: deploy-ubuntu.md, sidekick-pbx-setup.md and mcp-gateway.md.

Start with a workspace of your own.

Create an account, connect a model, and make your first agent from a template.

Create an account Read the specifications

Quick start

Start it on your machine.

Install the dependencies

Write the environment file

Start the stack

Set up the database

Start the services

Then make an agent, and talk to it.

Sign up, and create a workspace

Connect a model

Make an agent from a template

Publish it

Talk to it

For phone calls, start the gateway as well.

One Ubuntu server, everything in Docker.

Where to go next.

Start with a workspace of your own.