# 快速入门

在一分钟内上手 TokST。本指南将引导您完成安装、认证、创建第一个知识库和存储记忆。

## 智能体一键设置（最快方式）

复制以下消息，粘贴到您的 AI 智能体对话框中：

```
请阅读 https://tokst.com/skill.md 并按步骤安装 TokST 记忆技能。
先运行：curl -fsSL https://tokst.com/install.sh | bash

升级 CLI 时，安装程序会保留已有 TokST 连接。浏览器确认仅在首次连接或凭证失效时打开。
```

智能体会自动读取链接文档并自行安装独立 CLI、技能文件和 MCP 配置，然后完成浏览器授权。适用于 Claude Code、Cursor、Codex、ZCode 及任何兼容 MCP 的智能体。

完整指南请参阅[智能体设置](/docs/agent-setup)。

## 一键安装

安装 TokST 及所有依赖的最快方式：

```bash
curl -fsSL https://tokst.com/install.sh | bash
```

该脚本会下载通过 SHA-256 校验的 TokST 独立 CLI，打开浏览器授权，并让机器可以直接使用 `tokst` 命令。macOS 与 Linux 只需要 Unix 终端和 `curl`，Windows 使用 PowerShell。支持 macOS Apple Silicon、macOS Intel、Linux x64、Linux ARM64、Windows x64 与 Windows ARM64，无需安装 Bun、Node.js、npm 或包管理器。

Windows PowerShell：

```powershell
irm https://tokst.com/install.ps1 | iex
```

Windows Git Bash 也支持 `curl -fsSL https://tokst.com/install.sh | bash`；脚本会识别 Windows 并交给同一套 PowerShell 安装器执行。

可随时按当前安装渠道升级。独立版下载校验后的二进制，npm 与 Bun 版更新各自的全局包：

```bash
tokst update
tokst version
```

## 浏览器授权

安装脚本会打开 TokST 浏览器页面并保存已验证的本地凭据。可随时验证：

```bash
tokst doctor
tokst status
```

API 密钥用于 CI、服务端和无人值守自动化，可在[仪表盘](https://tokst.com/dashboard/api-keys)创建和管理。

## 连接仓库与智能体

在任意目录运行以下命令。TokST 会为选定的智能体写入本地指令并保留已有文件。知识库创建和目录绑定使用独立命令。

```bash
tokst init --agents codex,claude,cursor,opencode,pi
tokst doctor
```

需要主动刷新生成的集成文件时使用 `tokst init --force`。`tokst init` 不依赖 Git 或云端访问。`tokst doctor` 会检查认证、可选的 Git 和知识库绑定，以及已生成的智能体文件。

## 创建您的第一个知识库

**知识库**是一个命名的知识库，用于保存相关记忆。创建一个：

```bash
tokst atlas init --name "MyKnowledge"
tokst atlas bind --atlas-id <id>
```

您可以列出知识库来确认：

```bash
tokst atlas list
```

## 存储您的第一条记忆

记忆是 TokST 中的核心信息单元。存储一条：

```bash
tokst remember "Hello TokST!" --type note
```

您可以通过类型对记忆进行分类：`fact`、`decision`、`preference`、`task`、`architecture` 或 `note`。

附加文件或图片来丰富您的记忆：

```bash
tokst remember "Meeting notes with diagram" --file diagram.png
```

### 批量导入

从文件夹批量导入文件为记忆 — 文本文件自动提取内容：

```bash
tokst import ./my-docs --dry-run               # 先预览
tokst import ./my-docs --type note --tags imported  # 带标签导入
```

## 搜索您的记忆

通过关键词或语义搜索查找记忆：

```bash
tokst search "hello"
```

要获得更丰富的结果，请使用额外筛选条件：

```bash
tokst search "deployment" --type decision --tags production --limit 10
```

## 检查状态

随时查看您的账户和使用详情：

```bash
tokst status
```

要获取机器可读的输出（适用于脚本）：

```bash
tokst status --json
```

## MCP 服务器设置

要将 TokST 连接到支持 Model Context Protocol 的 AI 智能体（Claude Desktop、Cursor、Codex CLI），请将以下内容添加到您的 MCP 配置中：

```json
{
  "mcpServers": {
    "tokst": {
      "type": "streamable-http",
      "url": "https://api.tokst.com/mcp"
    }
  }
}
```

MCP 客户端会打开 TokST 完成 OAuth 授权，无需本地运行环境。请参阅 [MCP 服务器参考](/docs/mcp)了解针对特定客户端的配置详情。

## 下载附件

如果记忆包含文件附件，可以将它们下载到本地：

```bash
tokst memory download mem_xxxxx                    # 所有附件 → ~/Downloads
tokst memory download mem_xxxxx --out ./files      # 指定输出目录
tokst memory download mem_xxxxx --json             # JSON 格式输出
```

## 下一步

- 浏览 [CLI 参考](/docs/cli)了解所有可用命令
- 了解[记忆类型](/docs/memories)以及何时使用每种类型
- 设置[文件附件](/docs/attachments)以用文档丰富记忆
- 使用[工作区](/docs/workspaces)和[知识库](/docs/atlases)组织您的知识
- 通过[智能体一键设置](#智能体一键设置最快方式)为您的 AI 智能体配备持久记忆
