Quickstart

This is the fastest path from nothing to chatting with your own agent. The one-line installer detects Docker, asks a couple of questions, starts the server, and opens the setup wizard in your browser. Cremind is open source and early (version 0.0.1) — re-running the installer later upgrades in place.

1. Run the one-line installer

Pick the command for your operating system.

Linux / macOS:

curl -fsSL https://cremind.io/install.sh | bash

Windows (PowerShell):

iwr -useb https://cremind.io/install.ps1 | iex

The installer detects Docker and asks which mode you want. Both modes are idempotent — running the command again upgrades the existing install and keeps your config and database.

2. Choose Docker or native mode

The installer also asks a deployment type — local (only this machine can reach the backend), server (reachable from other machines), or custom (you set the host, URL, and CORS yourself). For a single-user desktop install, local is the right answer.

When it finishes, the installer waits for the backend's health check to pass, then opens your browser automatically.

Managing a Docker install

The compose bundle is yours to manage:

cd ~/.cremind/docker
docker compose ps                 # status
docker compose logs -f cremind    # follow the agent's logs
docker compose restart cremind    # restart just the agent
docker compose down               # stop everything

3. Finish the setup wizard

Your browser opens to the wizard at:

http://<host>:1515/#/setup

Walk through the steps:

1. Choose an LLM provider — Anthropic, OpenAI, or Groq — and paste your API key.
2. Choose a deployment type for how Cremind is reached.
3. Choose a database. SQLite is the default and needs no setup; Postgres, Qdrant, and ChromaDB are optional and selected per service.
4. Create your first profile. The first profile is named admin.

4. Send your first message

Once the wizard is done you land in the Web UI, served on port 1515. Type a message and the agent responds — that's your admin profile talking to the model you configured.

Behind the scenes, two listeners are running:

• the backend API on port 1112,
• the Web UI (Vue 3 + Vite) on port 1515.

Prefer the terminal? The cremind CLI gives you a streamed chat REPL against the same profile:

cremind chat

Run cremind --help to see every command — profiles, conversations, tools, agents, channels, and LLM config.

Next steps