Multica

https://multica.ai/docs
Admin
Multica is an open-source collaboration platform that coordinates AI coding agents and human...
Tokens:90,589
Snippets:836
Trust Score:8.8
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Connect to Multica Cloud

Source: https://multica.ai/docs/cli

Starts the first connection to Multica Cloud. The `setup` command saves the server address, opens a browser for sign-in, and starts the daemon.

```bash
multica setup
```

--------------------------------

### Install and setup Multica on Windows PowerShell

Source: https://multica.ai/docs/cloud-quickstart

Run these two commands in PowerShell on the target computer to install Multica and complete sign-in. The setup command opens a browser for authentication and leaves the daemon running in the background.

```powershell
irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex
multica setup
```

--------------------------------

### Install and setup Multica on macOS/Linux

Source: https://multica.ai/docs/cloud-quickstart

Run these two commands in a terminal on the target computer to install Multica and complete sign-in. The setup command opens a browser for authentication and leaves the daemon running in the background.

```bash
curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash
multica setup
```

--------------------------------

### Clone and start Multica with make dev

Source: https://multica.ai/docs/developers/contributing

Clones the Multica repository and starts the development environment. `make dev` prepares the environment, database, and migrations, then starts Web and API.

```bash
git clone https://github.com/multica-ai/multica.git
cd multica
make dev
```

--------------------------------

### Start worktree again

Source: https://multica.ai/docs/developers/contributing

Starts Web and API for the current worktree after it has been set up.

```bash
make start-worktree
```

--------------------------------

### Example agent instructions

Source: https://multica.ai/docs/agents-create

Example instructions for an agent that reviews frontend pull requests. Use as a template for defining an agent's responsibilities, checks, and delivery rules.

```text
You review frontend pull requests.

Read the diff and related tests first, and check only:
- React and TypeScript correctness
- Accessibility
- Consistency with existing component patterns

Do not modify code directly. Post findings in an issue comment,
ordered by severity; when nothing blocks, state clearly that the change can merge.
```

--------------------------------

### Full Workflow: make commands for environment management

Source: https://multica.ai/docs/developers/contributing

Commands to start, check, list, stop, destroy, garbage-collect, develop, verify, and build the project environment. `make up` allocates ports and database under a lock, verifies via DATABASE_URL and GET /health, and `make destroy` removes database, CLI profile, daemon workspaces, Desktop userData, and registry entry.

```makefile
make up               # Start this checkout's environment (C=api,web,daemon,desktop)
make status           # Show what is running and prove it is this environment
make list             # List every environment on this machine
make down             # Stop the processes, keep the database
make destroy          # Stop, then drop the database and free the slot
make gc               # Collect expired or directory-less environments
make dev              # Prepare and start the current checkout in the foreground
make check            # Run the complete local verification workflow
make build            # Build the server, CLI, and migrate binaries
```

--------------------------------

### Clone and start Multica with make selfhost

Source: https://multica.ai/docs/self-host-quickstart

Clone the Multica repository and run `make selfhost` to start the service. On first run, it creates `.env`, generates secrets, pulls images, and starts containers. Re-running reuses existing `.env` and volumes.

```bash
git clone --depth 1 https://github.com/multica-ai/multica.git
cd multica
make selfhost
```

--------------------------------

### Install Multica CLI with Homebrew

Source: https://multica.ai/docs/cli

Alternative installation method for macOS/Linux when Homebrew is installed.

```bash
brew install multica-ai/tap/multica
```

--------------------------------

### Start the Multica daemon

Source: https://multica.ai/docs/daemon-runtimes

Starts the Multica daemon in the background. Required on web, remote, or headless environments after installing the Multica CLI.

```bash
multica daemon start
```

--------------------------------

### Clone repository and install dependencies

Source: https://multica.ai/docs/mobile-app

Clone the Multica repository and install dependencies with pnpm. Requires Node.js, pnpm, and Git.

```bash
git clone https://github.com/multica-ai/multica.git
cd multica
pnpm install
```

--------------------------------

### Run daemon in foreground

Source: https://multica.ai/docs/troubleshooting

Run the daemon in the foreground to observe its startup directly. Stop the daemon first, then start it with --foreground.

```bash
multica daemon stop
multica daemon start --foreground
```

--------------------------------

### Check backend readiness with curl /readyz

Source: https://multica.ai/docs/self-host-quickstart

Run this command to confirm the backend, database, and migrations are ready. The expected response is {"status":"ok","checks":{"db":"ok","migrations":"ok"}}.

```bash
curl -fsS http://localhost:8080/readyz
```

--------------------------------

### Set up self-hosted profile and list issues with it

Source: https://multica.ai/docs/cli

Creates an isolated profile named 'staging' with custom server and app URLs, then uses that profile to list issues. Named profiles live under ~/.multica/profiles/<name>/config.json and keep separate server address, token, default workspace, and daemon state.

```shell
multica setup self-host --profile staging \
  --server-url https://api.staging.example.com \
  --app-url https://app.staging.example.com

multica issue list --profile staging
```

--------------------------------

### Install Multica CLI on macOS/Linux

Source: https://multica.ai/docs/self-host-quickstart

Installs the Multica CLI using the official install script. Run on the computer that runs your AI coding tools.

```bash
curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash
```

--------------------------------

### Set up a worktree for Multica development

Source: https://multica.ai/docs/developers/contributing

Creates a new worktree and sets up the environment for it. `make setup-worktree` generates `.env.worktree` with database name and ports derived from the path.

```bash
git worktree add ../multica-feature -b feat/my-change main
cd ../multica-feature
make setup-worktree
make start-worktree
```

--------------------------------

### Confirm Multica CLI installation

Source: https://multica.ai/docs/cli

Verifies that the Multica CLI is installed and displays its version.

```bash
multica version
```

--------------------------------

### Verify migrations with /readyz

Source: https://multica.ai/docs/self-host-quickstart

Check that the database and migrations are healthy after an upgrade. Expect HTTP 200 with both checks 'ok'. Anything else means the new version did not finish migrating.

```bash
curl -s localhost:8080/readyz
# {"status":"ok","checks":{"db":"ok","migrations":"ok"}}
```

--------------------------------

### Frontend: pnpm commands for web and desktop

Source: https://multica.ai/docs/developers/contributing

Install dependencies and run development, build, typecheck, lint, and test scripts for the frontend. Root commands exclude Mobile by default; Mobile has separate scripts and CI.

```bash
pnpm install
pnpm dev:web
pnpm dev:desktop
pnpm build
pnpm typecheck
pnpm lint
pnpm test
```

--------------------------------

### Install Multica CLI on Windows PowerShell

Source: https://multica.ai/docs/self-host-quickstart

Installs the Multica CLI using the official PowerShell script. Run on the computer that runs your AI coding tools.

```powershell
irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex
```

--------------------------------

### Minimal desktop.json configuration for self-hosted instance

Source: https://multica.ai/docs/desktop-app

Minimal required configuration: schemaVersion 1 and apiUrl. apiUrl is required and must use http or https. Other URLs are derived automatically. Save in the default locations (see table) and restart Desktop.

```json
{
  "schemaVersion": 1,
  "apiUrl": "https://api.example.com"
}
```

--------------------------------

### Full desktop.json configuration with explicit appUrl and wsUrl

Source: https://multica.ai/docs/desktop-app

Override derived URLs when the default derivation doesn't match your deployment. The example includes optional appUrl and wsUrl fields.

```json
{
  "schemaVersion": 1,
  "apiUrl": "https://api.example.com",
  "appUrl": "https://app.example.com",
  "wsUrl": "wss://ws.example.com/socket"
}
```

--------------------------------

### Build and install Release version on iPhone

Source: https://multica.ai/docs/mobile-app

Builds a Release version with no Metro dependency and installs it on the connected iPhone. The first build downloads iOS dependencies and compiles React Native; later builds reuse Xcode's cache.

```bash
pnpm ios:mobile:device:prod:release
```

--------------------------------

### Back up Postgres before upgrade (pg_dump to file)

Source: https://multica.ai/docs/self-host-quickstart

Take a dump of the Postgres database before upgrading. Redirects pg_dump output to a file first so its exit status is checked, then compresses with gzip. Use your own POSTGRES_USER/POSTGRES_DB if changed.

```bash
docker compose -f docker-compose.selfhost.yml exec -T postgres \
  pg_dump -U multica multica > multica-backup.sql && gzip multica-backup.sql
```
Tokens:
Raw