From 03310a581ac3927dcb860e894d4f0a38e6b7f657 Mon Sep 17 00:00:00 2001 From: Jiayuan Zhang Date: Tue, 14 Apr 2026 05:31:10 +0800 Subject: [PATCH] doc: document Homebrew CLI installation (#921) --- CLI_AND_DAEMON.md | 11 ++++++++--- CLI_INSTALL.md | 8 +++++++- README.md | 14 ++++++++++++-- README.zh-CN.md | 14 ++++++++++++-- SELF_HOSTING.md | 9 +++++++-- apps/docs/content/docs/cli/installation.mdx | 11 ++++++++--- .../docs/getting-started/cloud-quickstart.mdx | 18 ++++++++++++++++++ .../docs/getting-started/self-hosting.mdx | 7 +++++-- 8 files changed, 77 insertions(+), 15 deletions(-) diff --git a/CLI_AND_DAEMON.md b/CLI_AND_DAEMON.md index bb1e0ab3c..15296cfb0 100644 --- a/CLI_AND_DAEMON.md +++ b/CLI_AND_DAEMON.md @@ -7,8 +7,7 @@ The `multica` CLI connects your local machine to Multica. It handles authenticat ### Homebrew (macOS/Linux) ```bash -brew tap multica-ai/tap -brew install multica +brew install multica-ai/tap/multica ``` ### Build from Source @@ -22,11 +21,17 @@ cp server/bin/multica /usr/local/bin/multica ### Update +```bash +brew upgrade multica-ai/tap/multica +``` + +For install script or manual installs, use: + ```bash multica update ``` -This auto-detects your installation method (Homebrew or manual) and upgrades accordingly. +`multica update` auto-detects your installation method and upgrades accordingly. ## Quick Start diff --git a/CLI_INSTALL.md b/CLI_INSTALL.md index fcefb154f..3207b6c06 100644 --- a/CLI_INSTALL.md +++ b/CLI_INSTALL.md @@ -40,7 +40,7 @@ which brew If `brew` is found, install via Homebrew: ```bash -brew tap multica-ai/tap && brew install multica +brew install multica-ai/tap/multica ``` Then verify: @@ -51,6 +51,12 @@ multica version If the version prints successfully, skip to **Step 3**. +To upgrade later, run: + +```bash +brew upgrade multica-ai/tap/multica +``` + ### Option B: Download from GitHub Releases (macOS/Linux, no Homebrew) If Homebrew is not available, download the binary directly. diff --git a/README.md b/README.md index cc640f752..9ec023a88 100644 --- a/README.md +++ b/README.md @@ -50,13 +50,23 @@ Multica manages the full agent lifecycle: from task assignment to execution moni ## Quick Install +### macOS / Linux (Homebrew - recommended) + +```bash +brew install multica-ai/tap/multica +``` + +Use `brew upgrade multica-ai/tap/multica` to keep the CLI current. + +### macOS / Linux (install script) + ```bash curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash ``` -Installs the Multica CLI on macOS and Linux. Works with Homebrew or downloads the binary directly. +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):** +### Windows (PowerShell) ```powershell irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex diff --git a/README.zh-CN.md b/README.zh-CN.md index b80d7c402..da6b6f88f 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -50,13 +50,23 @@ Multica 管理完整的 Agent 生命周期：从任务分配到执行监控再 ## 快速安装 +### macOS / Linux（推荐 Homebrew） + +```bash +brew install multica-ai/tap/multica +``` + +后续可用 `brew upgrade multica-ai/tap/multica` 更新 CLI。 + +### macOS / Linux（安装脚本） + ```bash curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash ``` -安装 Multica CLI，支持 macOS 和 Linux。有 Homebrew 用 Homebrew，没有则直接下载二进制。 +如果没有 Homebrew，可以使用安装脚本。脚本会安装 Multica CLI：检测到 `brew` 时通过 Homebrew 安装，否则直接下载二进制。 -**Windows (PowerShell):** +### Windows (PowerShell) ```powershell irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex diff --git a/SELF_HOSTING.md b/SELF_HOSTING.md index 92decb875..362d7bf40 100644 --- a/SELF_HOSTING.md +++ b/SELF_HOSTING.md @@ -29,6 +29,12 @@ This clones the repository, starts all services via Docker Compose, installs the Open http://localhost:3000, log in with any email + verification code **`888888`**. > **Prerequisites:** Docker and Docker Compose must be installed. The script checks for this and provides install links if missing. +> +> **CLI only?** If the self-host server is already running and you only need the CLI on a macOS/Linux machine, install it with Homebrew: +> +> ```bash +> brew install multica-ai/tap/multica +> ``` --- @@ -70,8 +76,7 @@ Each team member who wants to run AI agents locally needs to: ### a) Install the CLI and an AI agent ```bash -brew tap multica-ai/tap -brew install multica +brew install multica-ai/tap/multica ``` You also need at least one AI agent CLI installed: diff --git a/apps/docs/content/docs/cli/installation.mdx b/apps/docs/content/docs/cli/installation.mdx index 9e817bbc4..40d18c4d4 100644 --- a/apps/docs/content/docs/cli/installation.mdx +++ b/apps/docs/content/docs/cli/installation.mdx @@ -8,8 +8,7 @@ description: Install the Multica CLI and start the agent daemon. ### Homebrew (macOS/Linux) ```bash -brew tap multica-ai/tap -brew install multica +brew install multica-ai/tap/multica ``` ### Build from Source @@ -48,11 +47,17 @@ rm /tmp/multica.tar.gz ### Update +```bash +brew upgrade multica-ai/tap/multica +``` + +For install script or manual installs, use: + ```bash multica update ``` -This auto-detects your installation method (Homebrew or manual) and upgrades accordingly. +`multica update` auto-detects your installation method and upgrades accordingly. ## Quick Start diff --git a/apps/docs/content/docs/getting-started/cloud-quickstart.mdx b/apps/docs/content/docs/getting-started/cloud-quickstart.mdx index 278913861..9f71a7114 100644 --- a/apps/docs/content/docs/getting-started/cloud-quickstart.mdx +++ b/apps/docs/content/docs/getting-started/cloud-quickstart.mdx @@ -19,10 +19,28 @@ Fetch https://github.com/multica-ai/multica/blob/main/CLI_INSTALL.md and follow Or install manually: +### macOS / Linux (Homebrew - recommended) + +```bash +brew install multica-ai/tap/multica +``` + +### macOS / Linux (install script) + ```bash # Install the CLI curl -fsSL https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.sh | bash +``` +### Windows (PowerShell) + +```powershell +irm https://raw.githubusercontent.com/multica-ai/multica/main/scripts/install.ps1 | iex +``` + +Then configure, authenticate, and start the daemon: + +```bash # Configure, authenticate, and start the daemon multica setup ``` diff --git a/apps/docs/content/docs/getting-started/self-hosting.mdx b/apps/docs/content/docs/getting-started/self-hosting.mdx index db16a4b90..12824ab0a 100644 --- a/apps/docs/content/docs/getting-started/self-hosting.mdx +++ b/apps/docs/content/docs/getting-started/self-hosting.mdx @@ -33,6 +33,10 @@ multica setup self-host This clones the repo, starts all services, installs the CLI, and configures it for localhost. Then open http://localhost:3000 — log in with any email + code **`888888`**. + +If the self-host server is already running and you only need the CLI on a macOS/Linux machine, install it with Homebrew: `brew install multica-ai/tap/multica`. + + For a step-by-step setup, see below. @@ -73,8 +77,7 @@ The daemon runs on your local machine (not inside Docker). It detects installed ### a) Install the CLI and an AI agent ```bash -brew tap multica-ai/tap -brew install multica +brew install multica-ai/tap/multica ``` You also need at least one AI agent CLI: