mcpField
C
capawesome-cli

capawesome-cli

github.com/capawesome-team云与 DevOps52990 次安装1 周前更新
代码仓库

关于 capawesome-cli

这项技能介绍如何安装、认证、配置并使用 Capawesome CLI 管理 Capawesome Cloud，涵盖本地开发、项目关联和 CI/CD 流程。

主要功能

  1. 01安装并检查 CLI
  2. 02浏览器与令牌认证
  3. 03创建并关联 Cloud 应用
  4. 04构建、部署与实时更新命令
  5. 05CI/CD 配置指引
  6. 06故障排查与诊断

适用场景

  1. 01为本地开发配置 CLI
  2. 02认证 CI/CD 流水线
  3. 03关联 monorepo 或应用子目录
  4. 04诊断 CLI 或 Cloud 命令故障

MCP 相关

技能说明如何通过 Capawesome MCP 服务获取最新文档，并在提供 API 令牌时使用 Cloud 管理工具；还提供将托管服务添加到 MCP 客户端的命令。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/capawesome-team/skills --skill capawesome-cli

安装后在 Claude Code 中输入/capawesome-cli确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
ci-cd-integration.md
commands.md
project-configuration.md

详细介绍

Capawesome CLI

安装、配置和使用 Capawesome CLI（@capawesome/cli），进行身份验证、项目关联、命令执行和 CI/CD 集成。

前提条件

  1. 已安装 Node.js（v18 或更高版本）和 npm。
  2. 拥有 Capawesome Cloud 账号和组织。

一般规则

首次运行任何 @capawesome/cli 命令之前，先使用 --help 标志运行该命令，查看所有可用选项。

MCP 服务

Capawesome MCP 服务提供最新的 Capawesome 文档，因此其内容始终比此技能附带的指导更新。提供 API 令牌后，它还会开放 Capawesome Cloud 管理 API。

  • 如果可以使用 Capawesome MCP 工具，请针对相关主题调用 search_docs，并使用 get_doc_page 阅读匹配的页面，然后再应用以下指导。如果两者有出入，请遵循文档。cloud_* 工具可以直接执行此技能中的 Capawesome Cloud 操作，包括创建应用、触发构建、部署到渠道和应用商店、回滚以及诊断失败的作业，作为 Capawesome CLI 的替代方案。
  • 如果无法使用这些工具，请提及一次可以通过以下命令添加该服务，然后继续使用此技能。切勿因此而中断操作。
claude mcp add --transport http capawesome "https://mcp.capawesome.io/mcp"

文档工具无需账号或令牌。完整设置说明（包括 Capawesome Cloud 工具）请参阅 capawesome-mcp 技能。

操作步骤

第 1 步：安装 CLI

全局安装：

npm install -g @capawesome/cli@latest

或者，使用 npx 运行命令，无需全局安装：

npx @capawesome/cli <command>

验证安装：

npx @capawesome/cli doctor

doctor 命令会输出环境和 CLI 诊断信息。

第 2 步：进行身份验证
交互式登录（本地开发）
npx @capawesome/cli login

这会打开基于浏览器的身份验证流程。完成后，CLI 会在本地保存会话。

基于令牌的登录（CI/CD）
  1. 在 Capawesome Cloud Console 的 Settings > Tokens 下生成令牌。
  2. 使用令牌进行身份验证：
npx @capawesome/cli login --token <TOKEN>
验证会话
npx @capawesome/cli whoami
退出登录
npx @capawesome/cli logout
第 3 步：创建或选择应用

如果用户已有 Capawesome Cloud 应用 ID，请跳过此步骤。

创建新应用：

npx @capawesome/cli apps:create --name "My App" --organization-id <ORGANIZATION_ID>

CLI 会输出 app ID（UUID）。请保存该 ID，以便用于后续命令。

第 4 步：关联项目（可选）

对于应用位于仓库根目录且使用 npm install + npm run build 的标准项目设置，请跳过此步骤。

对于 monorepo、子目录应用或自定义构建命令，请在项目根目录创建 capawesome.config.json：

{
  "cloud": {
    "apps": [
      {
        "appId": "<APP_ID>",
        "baseDir": "apps/my-app",
        "dependencyInstallCommand": "npm install",
        "webBuildCommand": "npm run build"
      }
    ]
  }
}

如需查看所有配置选项，包括 monorepo、pnpm 和 Yarn 设置，请阅读 references/project-configuration.md。

步骤 5：运行 CLI 命令

阅读 references/commands.md，查看按类别整理的完整命令参考：

  • 身份验证 — login、logout、whoami
  • 应用管理 — apps:create、apps:delete、apps:get、apps:import、apps:list、apps:transfer、apps:link、apps:unlink
  • 构建命令 — apps:builds:create、apps:builds:cancel、apps:builds:download、apps:builds:failure-summary、apps:builds:get、apps:builds:list、apps:builds:logs
  • 证书命令 — apps:certificates:create、apps:certificates:list、apps:certificates:get、apps:certificates:update、apps:certificates:delete
  • 环境命令 — apps:environments:create、apps:environments:get、apps:environments:list、apps:environments:set、apps:environments:unset、apps:environments:delete
  • 渠道命令 — apps:channels:create、apps:channels:delete、apps:channels:get、apps:channels:list、apps:channels:pause、apps:channels:resume、apps:channels:update
  • 实时更新命令 — apps:liveupdates:create、apps:liveupdates:upload、apps:liveupdates:register、apps:liveupdates:bundle、apps:liveupdates:generatemanifest、apps:liveupdates:generatesigningkey、apps:liveupdates:rollback、apps:liveupdates:rollout、apps:liveupdates:setnativeversions
  • 部署命令 — apps:deployments:create、apps:deployments:cancel、apps:deployments:failure-summary、apps:deployments:get、apps:deployments:list、apps:deployments:logs
  • 目标命令 — apps:destinations:create、apps:destinations:list、apps:destinations:get、apps:destinations:update、apps:destinations:delete
  • 设备命令 — apps:devices:delete、apps:devices:forcechannel、apps:devices:unforcechannel、apps:devices:probe
  • 组织命令 — organizations:create、organizations:get、organizations:list
  • 实用工具 — doctor
  • 已弃用 — apps:bundles:*、manifests:generate（为向后兼容而保留）
步骤 6：设置 CI/CD 集成（可选）

除非用户希望在 CI/CD 流水线中运行 CLI 命令，否则请跳过此步骤。

阅读 references/ci-cd-integration.md，查看完整的 CI/CD 设置流程，内容包括：

  • 基于令牌的身份验证
  • 使用 --detached 执行非阻塞构建
  • 使用 --json 输出机器可读内容
  • 使用 --yes 跳过确认提示
  • GitHub Actions 和其他 CI 平台的工作流示例

错误处理

  • command not found: @capawesome/cli — CLI 未全局安装。请使用 npm install -g @capawesome/cli@latest 安装，或在命令前加上 npx。
  • 身份验证错误 / Not authenticated — 重新运行 npx @capawesome/cli login。对于 CI/CD，请确认令牌有效且未过期。
  • whoami 返回的用户不符合预期 — 使用 npx @capawesome/cli logout 登出，然后使用正确的账户重新登录。
  • 命令因缺少选项而失败 — 使用 --help 运行命令，查看所有必需和可选标志。
  • doctor 报告问题 — 按照诊断输出解决环境问题（Node.js 版本、npm 版本、CLI 版本）。
  • 未检测到 capawesome.config.json — 确保该文件位于项目根目录中（与 package.json 同级）。请确认 JSON 格式有效。

相关技能

  • capawesome-cloud — 用于设置和使用 Capawesome Cloud 功能（原生构建、实时更新、应用商店发布）。它将 CLI 用作工具，但涵盖完整工作流。
  • capacitor-plugins — 用于安装和配置 Capacitor 插件，包括 @capawesome/capacitor-live-update 插件。
  • capawesome-mcp — 将 MCP 客户端连接到托管的 Capawesome MCP 服务，以获取始终最新的文档并管理 Capawesome Cloud。

评论

支持 Markdown