mirror of
https://github.com/multica-ai/multica.git
synced 2026-07-26 20:45:37 +02:00
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
This commit is contained in:
45
README.md
45
README.md
@@ -67,7 +67,12 @@ Multica manages the full agent lifecycle: from task assignment to execution moni
|
||||
|
||||
## Quick Install
|
||||
|
||||
### macOS / Linux (Homebrew - recommended)
|
||||
<details open>
|
||||
<summary><b>macOS / Linux</b></summary>
|
||||
|
||||
<br/>
|
||||
|
||||
### 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.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Windows (PowerShell)</b></summary>
|
||||
|
||||
<br/>
|
||||
|
||||
### 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.
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -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.
|
||||
|
||||
<details open>
|
||||
<summary><b>macOS / Linux</b></summary>
|
||||
|
||||
<br/>
|
||||
|
||||
```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
|
||||
```
|
||||
</details>
|
||||
<details>
|
||||
<summary><b>Windows (PowerShell)</b></summary>
|
||||
|
||||
<br/>
|
||||
|
||||
```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
|
||||
```
|
||||
</details>
|
||||
|
||||
This installs the `multica` CLI, checks out the latest self-host assets, pulls the official Multica images from GHCR, and configures everything for localhost.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user