From ffc66c68ffc58eb969a75545bfc3cff4d6a1a8c0 Mon Sep 17 00:00:00 2001 From: ohyun_227 Date: Fri, 24 Jul 2026 13:55:36 +0900 Subject: [PATCH] MUL-5245: docs: add Windows install instructions and split OS-specific steps into collapsible sections (#5859) * docs: add windows self-hosting * docs: add windows self-hosting --- README.md | 45 +++++++++++++++++++++++++++++++++++++-------- SELF_HOSTING.md | 21 ++++++++++++++++++++- 2 files changed, 57 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 38bbc9e00..371a82ea7 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,12 @@ Multica manages the full agent lifecycle: from task assignment to execution moni ## Quick Install -### macOS / Linux (Homebrew - recommended) +
+macOS / Linux + +
+ +### Homebrew (recommended) ```bash brew install multica-ai/tap/multica @@ -75,7 +80,7 @@ brew install multica-ai/tap/multica Use `brew upgrade multica-ai/tap/multica` to keep the CLI current. -### macOS / Linux (install script) +### Install script ```bash curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash @@ -83,12 +88,6 @@ curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/ins Use this if Homebrew is not available. The script installs the Multica CLI on macOS and Linux by using Homebrew when it is on `PATH`, otherwise it downloads the binary directly. -### Windows (PowerShell) - -```powershell -irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex -``` - Then configure, authenticate, and start the daemon in one command: ```bash @@ -105,6 +104,36 @@ multica setup # Connect to Multica Cloud, log in, start daemon > This pulls the official Multica images from GHCR (latest stable by default). Requires Docker. See the [Self-Hosting Guide](SELF_HOSTING.md) for details. > If the selected GHCR tag has not been published yet, fall back to `make selfhost-build` from a checkout. +
+ +
+Windows (PowerShell) + +
+ +### PowerShell + +```powershell +irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex +``` + +Then configure, authenticate, and start the daemon in one command: + +```powershell +multica setup # Connect to Multica Cloud, log in, start daemon +``` + +> **Self-hosting?** Set the `MULTICA_MODE` environment variable to `with-server` before running the installer to deploy a full Multica server on your machine: +> +> ```powershell +> $env:MULTICA_MODE="with-server"; irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex +> multica setup self-host +> ``` +> +> This pulls the official Multica images from GHCR (latest stable by default). Requires Docker. See the [Self-Hosting Guide](SELF_HOSTING.md) for details. + +
+ --- ## Getting Started diff --git a/SELF_HOSTING.md b/SELF_HOSTING.md index 0ed76a5a1..114a24a23 100644 --- a/SELF_HOSTING.md +++ b/SELF_HOSTING.md @@ -14,7 +14,12 @@ Each user who runs AI agents locally also installs the **`multica` CLI** and run ## Quick Install (Recommended) -Two commands to set up everything — server, CLI, and configuration: +Two commands to set up everything — server, CLI, and configuration. + +
+macOS / Linux + +
```bash # 1. Install CLI + provision the self-host server @@ -23,6 +28,20 @@ curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/ins # 2. Configure CLI, authenticate, and start the daemon multica setup self-host ``` +
+
+Windows (PowerShell) + +
+ +```powershell +# 1. Install CLI + provision the self-host server +$env:MULTICA_MODE="with-server"; irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex + +# 2. Configure CLI, authenticate, and start the daemon +multica setup self-host +``` +
This installs the `multica` CLI, checks out the latest self-host assets, pulls the official Multica images from GHCR, and configures everything for localhost.