> ## Documentation Index
> Fetch the complete documentation index at: https://octop.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Octop 快速入门：几分钟内完成安装与运行

> 在 macOS、Linux 或 Windows 上安装 Octop，运行 octop init，完成首次设置向导，然后在几分钟内开始聊天。

Octop 是一个自托管的多用户 AI 助手，完全运行在您自己的机器上。在本指南中，您将安装 `octop` CLI，运行 `octop init`，启动服务器，完成首次设置向导，并发送第一条消息——整个过程不到五分钟。

**1. 安装 Octop**

选择适合您平台的安装方式。每种方法都会在 `~/.octop/venv` 处配置一个隔离环境，并通过 `~/.octop/bin` 将 `octop` 添加到您的 PATH 中——无需系统 Python。

```bash macOS / Linux theme={null}
curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.sh | bash
```

```powershell Windows (PowerShell) theme={null}
irm https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.ps1 | iex
```

```bat Windows (cmd) theme={null}
curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.bat -o install.bat
install.bat
```

```bash PyPI（已有 Python 环境） theme={null}
pip install octop
```

**2. 重新加载 shell**

打开**新的终端**，或重新加载当前 shell 会话，以便 PATH 能够识别 `~/.octop/bin`：

```bash Zsh theme={null}
source ~/.zshrc
```

```bash Bash theme={null}
source ~/.bashrc
```

> [!NOTE]
>
> 在 Windows 上，安装程序会自动更新用户 PATH——关闭并重新打开终端以使更改生效。无需执行 shell 重载命令。

确认安装成功：

```bash theme={null}
octop --version
```

**3. 初始化 Octop**

初始化本地环境：

```bash theme={null}
octop init
```

这会准备好 `~/.octop/`（数据库、密钥等相关文件）。所有数据都保留在您机器的 `~/.octop/` 目录下。

**4. 启动服务器**

在前台启动 Octop：

```bash theme={null}
octop run
```

看到服务器就绪消息后，打开浏览器并访问：

```text theme={null}
http://127.0.0.1:8088
```

首次启动时，页面会进入**设置向导**。请先到用户主目录打开 `~/octop-login.txt`，将其中的一次性设置密码粘贴到向导中，然后自行设置管理员用户名和密码。

> [!NOTE]
>
> 该文件位于用户主目录的 `~/octop-login.txt`，不在 `~/.octop/` 下。设置完成后 Octop **不再删除**该文件；请使用您自设的用户名和密码登录。Docker 首次启动使用另一套默认账号（`admin` / `Octop123`）——见 [Docker 部署](https://octop.mintlify.site/zh/quickstart-docker.md)。

如需绑定所有网络接口或使用不同端口，直接传递参数即可：

```bash theme={null}
octop run --host 0.0.0.0 --port 9000
```

如需将 Octop 作为持久后台服务运行（systemd、launchd 或 Windows Service），请使用：

```bash theme={null}
octop service start
```

**5. 配置模型提供商**

Octop 内置了腾讯云、OpenAI、Anthropic、DeepSeek、Ollama 等大量预设。在页面中添加您的第一个提供商：

```text theme={null}
管理 → 模型
```

![模型管理](https://mintcdn.com/octop/P_aBdthWeK4YndCE/images/ui-models.png?fit=max\&auto=format\&n=P_aBdthWeK4YndCE\&q=85\&s=6a2563aba21600a6c402a6014dac18bb)

选择一个预置提供商，填入 API 密钥并启用。它的模型会进入可用模型池，供您账户下的所有专家使用。

> [!TIP]
>
> 更习惯终端？使用 `octop models config`——详见 [专家命令](https://octop.mintlify.site/zh/cli/agent-commands.md#octop-models)。

**6. 开始聊天**

打开页面的**聊天**，地址为 `http://127.0.0.1:8088`。选择您的专家（设置向导会创建一个默认的 `main` 专家）并发送第一条消息。

![聊天](https://mintcdn.com/octop/P_aBdthWeK4YndCE/images/ui-chat.png?fit=max\&auto=format\&n=P_aBdthWeK4YndCE\&q=85\&s=0acc0cf987d6a8bd6e9891ea9230dd46)

从现在开始，您的专家将能够使用您配置的所有技能、连接器和工具。

> [!TIP]
>
> 终端交互式聊天见 [`octop chats`](https://octop.mintlify.site/zh/cli/agent-commands#octop-chats)。

> [!NOTE]
>
> 基础安装程序会设置核心平台。如需解锁额外功能，请使用 `--extras` 参数重新运行安装程序：
>
> ```bash theme={null}
> # 浏览器自动化（Playwright Chromium）
> curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.sh | bash -s -- --extras browser
>
> # 飞书渠道支持
> curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.sh | bash -s -- --extras channels-feishu
> ```
>
> 浏览器自动化支持无头 Chromium 会话，用于网页任务和截图。飞书扩展添加了一个渠道桥接，让您的专家能够接收和回复飞书消息。

> [!TIP]
>
> 对于生产部署或多用户环境，请使用 Docker Compose 而非裸机安装。请参阅 [Docker 部署指南](https://octop.mintlify.site/zh/quickstart-docker.md)。飞牛 NAS 安装见 [FnOS](https://octop.mintlify.site/zh/guides/fnos.md)。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.