Synchain 快速上手 从注册到第一次 API 调用
这一页带你从一个新注册的账号走到一个可用的 Synchain CLI，并完成第一次带鉴权的 HTTP API 调用。下面的命令可以直接复制到终端里运行，尖括号里的占位符请先换成你自己的值。
只在浏览器里用 Synchain 的话，第 1 步就够了。第 2 步是给想把 DAW 声音推进 Creative Space 的音乐人准备的；第 3 到第 7 步面向脚本、CI 流水线和 AI agent。
分步操作
注册免费账号
用邮箱注册，然后新建一个项目，或通过邀请链接加入别人的项目。下面的每一步都作用于你账号所在的项目。
在 DAW 里安装 Synchain Bridge（可选，用于实时传送 DAW 音频）
Synchain Bridge 是 DAW 插件（Windows 上为 VST3，Apple Silicon Mac 上为 VST3 与 AU），负责把工程音频送进 Creative Space。只用 CLI 或 API 的话可以跳过这一步。下载与安装步骤见下载页。
安装 CLI
Synchain CLI 需要 Node.js 20 或更高版本。用 npm 全局安装后，确认一下装上的版本。全部命令与参数见命令参考。
npm i -g @synchain/cli synchain --version生成 CLI key
登录后打开账号设置 → CLI 访问，勾选这把 key 可以访问的板块，然后生成 key。key 只显示一次，请立即复制；重新生成会让旧 key 立刻失效。在每个项目内，由项目管理员在「项目设置 → 项目级 CLI 访问」里决定 CLI 能访问哪些板块。只有你的 key 和项目两边都允许，CLI 才能访问该板块；「项目文件」与「讨论」默认开启。
登录并选择项目
synchain login会先询问服务地址（直接回车使用默认值），再以隐藏输入的方式询问 key。key 不接受以命令行参数传入——那样会留在 shell 历史里；在 CI 中，请把它放进SYNCHAIN_TOKEN环境变量并加上--base-url，这样就不会弹出任何询问。之后列出你能访问的项目并选定一个：project use接受project ls列出的 ID。synchain login synchain project ls synchain project use <project-id>上传文件并读回
把一个本地文件上传到当前项目的根目录，再以 JSON 列出根目录的文件，确认它已经到位。把
./mix.wav换成你机器上真实的文件路径。需要 @synchain/cli 0.9.0 或更高版本。
synchain files upload ./mix.wav synchain files ls --format json直接调用 API
同一把 key 也可以作为 Bearer 令牌调用 HTTP API。不要把 key 直接写进
export命令——那样它会留在 shell 历史里；请运行read -rs SYNCHAIN_TOKEN && export SYNCHAIN_TOKEN，粘贴 key 后回车（输入不会回显）。之后，下面这条请求会以 JSON 返回你的账号信息和你能访问的项目。这里的命令适用于 bash 或 zsh（macOS、Linux、WSL 或 Git Bash）。curl -H "Authorization: Bearer $SYNCHAIN_TOKEN" https://dev.synchain.ca/api/user/me
给 AI agent
agent 应先读 /AGENTS.md 和agent 安装指南。三个习惯涵盖了大部分要点：以 JSON 读取命令树；每个写操作先用 --dry-run 演练再真正执行；用 synchain doctor 检查本地配置，它不会调用 API。把 key 交给 agent 时请通过 SYNCHAIN_TOKEN，不要贴进对话或命令行。
需要 @synchain/cli 0.9.0 或更高版本。
synchain --help --format json
synchain files rm <file-id> --dry-run --format json
synchain doctor --json