PartyKit CLI 命令行工具完全指南

什么是PartyKit CLI

PartyKit CLI 是一个功能强大的命令行工具，它允许开发者直接在终端中开发、部署和管理 PartyKit 项目。这个工具不仅简化了本地开发流程，还能与持续集成环境无缝集成，实现自动化部署工作流。

安装指南

安装 PartyKit CLI 非常简单，只需运行以下命令：

npm install partykit@latest

安装完成后，你就可以在项目中使用各种 PartyKit 命令了。

核心命令详解

项目初始化

使用 npx partykit init 命令可以快速初始化一个 PartyKit 项目。这个命令会：

1. 将最新版本的 PartyKit 安装到你的项目中
2. 创建 partykit.json 配置文件
3. 生成示例的 client.ts 和 server.ts 文件作为项目起点

项目名称会自动从你的 package.json 文件中获取。

本地开发

npx partykit dev 命令会启动本地开发服务器，具有以下特点：

• 实时监控代码变更
• 自动重启服务器
• 默认使用 partykit.json 中 main 字段指定的入口文件
• 也可以手动指定入口文件：npx partykit dev src/server.ts

项目部署

npx partykit deploy 是将项目部署到 PartyKit 平台的核心命令：

• 使用 partykit.json 中的配置信息
• 可自定义入口文件和项目名称：npx partykit deploy src/server.ts --name my-project
• 首次运行时会自动触发登录流程

日志查看

调试线上问题时，npx partykit tail 命令非常有用：

• 实时查看项目日志
• 包含错误信息和访问记录
• 支持指定项目名称：npx partykit tail --name my-project

项目管理

• npx partykit list：列出所有已部署项目
• npx partykit delete：删除指定项目（可加 --name 参数）

环境变量管理

PartyKit 提供了一套完整的命令来管理环境变量：

基本操作

• npx partykit env list：列出所有环境变量
• npx partykit env add <key>：添加/更新环境变量（会提示输入值）
• npx partykit env remove <key>：删除环境变量

注意：修改环境变量后需要重新部署才能生效。

批量操作

• npx partykit env pull [filename]：将环境变量导出到文件（默认更新 partykit.json）
• npx partykit env push：将 partykit.json 中的变量推送到平台

认证与授权

用户认证

• npx partykit login：登录 PartyKit 服务（会打开浏览器进行认证）
• npx partykit logout：登出当前用户
• npx partykit whoami：显示当前登录用户

CI/CD 集成

npx partykit token generate 可以生成 OAuth 令牌，用于：

• GitHub Actions 自动化部署
• 持续集成环境
• 每次运行都会生成新令牌

最佳实践建议

1. 开发流程：建议先使用 dev 命令进行本地开发测试，确认无误后再部署
2. 环境变量：敏感信息应通过环境变量管理，不要硬编码在代码中
3. CI/CD：在自动化流程中使用生成的令牌，而非个人账户凭证
4. 日志监控：部署后使用 tail 命令监控实时日志，快速定位问题

通过掌握这些 CLI 命令，你可以高效地开发和管理 PartyKit 项目，无论是个人开发还是团队协作都能得心应手。