cloudbase-declarative-deploy skill
✓ 検証済みbuild-plan-applyワークフローと宣言的なcloudbaserc設定を使用して、CloudBaseプロジェクトをデプロイします。
- GitHubスター
- 1,164
- ファイル
- 5
- 最終コミット
- 2026年11月11日
- ライセンス
- MIT
- 許可されたツール
- —
cloudbase-declarative-deploy skillは何をしますか
build-plan-applyワークフローと宣言的なcloudbaserc設定を使用して、CloudBaseプロジェクトをデプロイします。
skillのSKILL.mdから生成された要約。
cloudbase-declarative-deploy skill について
このSKILLは、複雑なクラウドインフラを管理する開発者が、CloudBaseプロジェクト全体を単一の「あるべき状態」としてデプロイすることを可能にします。cloudbaserc設定ファイルを使用することで、エージェントはデータベース、関数、アプリケーション、ホスティング、ゲートウェイのデプロイを、特定の依存関係の順序でオーケストレートできます。これは、環境の上書き機能を使用して、本番環境やステージング環境などのマルチ環境構成を管理するチームにとって特に有用です。
ローカル環境では、ワークフローは厳格なbuild-plan-applyシーケンスに従います。エージェントは、まず静的ホスティングアーティファクトに対してdeployBuildを使用し、次にdeployPlanを実行してドライランを行い変更内容をプレビューし、最後に確認フラグを付けてdeployApplyを実行して変更を確定させる必要があります。ローカルファイルシステムが利用できないクラウドホスト型のMCPモードでは、このSKILLは関数とアプリケーション用の2ステップのアップロードチャネルに切り替わり、ローカルのシェルコマンドの代わりにクラウド側のパイプラインを利用します。これにより、ローカルアクセスがなくても、セキュアなアップロードURLとクラウドベースのビルドプロセスを介してリソースをデプロイできます。
エージェントができること
- 1インフラ変更のプレビュー実際の変更を適用する前に、ドライランを実行して、どのリソースが作成、更新、またはスキップされるかを正確に確認できます。
- 2マルチリソースプロジェクトのデプロイ単一の設定ファイルを使用して、データベースや関数を含む完全なプロジェクトをデプロイします。
- 3マルチ環境デプロイの管理環境の上書きを使用して、本番環境やステージング環境などの異なるデプロイ先を管理します。
- 4静的ホスティングのローカルビルドデプロイプロセスが開始される前に、ホスティングサイト用のローカルビルドアーティファクトを生成します。
skill の SKILL.md から作成されています。すべてのユースケースは、その引用と照合されています。
cloudbase-declarative-deploy skillのインストール方法
各コマンドはskillフォルダをクライアントのskillsディレクトリにコピーします。読み込むには、クライアントを再起動するか新しいセッションを開始してください。Claude Codeにcloudbase-declarative-deploy skillをインストールする
~/.claude/skills/cloudbase-declarative-deploy/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy ~/.claude/skills/cloudbase-declarative-deployClaude Code (project)にcloudbase-declarative-deploy skillをインストールする
.claude/skills/cloudbase-declarative-deploy/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy .claude/skills/cloudbase-declarative-deployCodexにcloudbase-declarative-deploy skillをインストールする
~/.agents/skills/cloudbase-declarative-deploy/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy ~/.agents/skills/cloudbase-declarative-deployGemini CLIにcloudbase-declarative-deploy skillをインストールする
~/.gemini/skills/cloudbase-declarative-deploy/SKILL.md
$ npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy ~/.gemini/skills/cloudbase-declarative-deployClaude.aiにcloudbase-declarative-deploy skillをインストールする
npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy cloudbase-declarative-deploy && zip -r cloudbase-declarative-deploy.zip cloudbase-declarative-deploy # claude.ai → Customize → Skills → + → Create skill → Upload a skill → cloudbase-declarative-deploy.zip
自動チェック
実行日 2026年11月15日完全なレポート →自動チェックに合格しました。これはセキュリティ監査ではありません。エージェントに実行させる前にスクリプトを読んでください。 チェックの仕組み
- ソースリポジトリがリンクされており、アクセス可能tencentcloudbase/cloudbase-ai-toolkit/config/.claude/skills/cloudbase-declarative-deploy is public and reachablegithub.com/tencentcloudbase/cloudbase-ai-toolkit/tree/HEAD/c ↗合格
- オープンソースライセンス (OSI)MITspdx.org/licenses/MIT.html ↗合格
- 過去1年以内にコミットまたはリリースありLast commit 2026-11-11github.com/tencentcloudbase/cloudbase-ai-toolkit/commits ↗合格
- スクリプトにダウンロード実行や認証情報の窃取がないNo scripts in the skill folder合格
- SKILL.md に隠れた指示がないNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗合格
- 事前許可ツールが限定されているNo pre-approved tools; the agent asks before using onegithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗合格
- SKILL.md が Agent Skills の形式に従っているValid name and description; says when to use it; 261 linesgithub.com/tencentcloudbase/cloudbase-ai-toolkit/blob/HEAD/c ↗合格
SKILL.md
GitHubで表示CloudBase Declarative Deploy
Deploy a whole CloudBase project from one cloudbaserc config as desired state,
using the deployBuild (local hosting build), deployPlan (dry-run) and deployApply
(apply) MCP tools. The orchestrator applies resources in a fixed dependency order:
database → functions → app → hosting → gateway
Sibling skills (local only)
Sibling CloudBase skills ship beside this skill. Use local relative paths such as
../cloudbase-cli/SKILL.md.
Cloud-hosted MCP mode does not guarantee access to a local workspace filesystem or stable relative paths. If a referenced sibling file is not available in cloud mode, use this skill's embedded guidance as source of truth and ask the user for any missing constraints (or to install the missing skill). Do not HTTP-fetch remote skill or protocol markdown into the agent context.
Cross-cutting protocols (required before applying any deploy):
- Change Safety Protocol:
../cloudbase-platform/references/protocols/change-safety-protocol.md - Deployment Gate:
../cloudbase-platform/references/protocols/deployment-gate.md
When to use this skill
- The project has a
cloudbaserc.json/.yaml/.yml/.jsdescribing multiple resources, and the user wants to deploy them together as one config. - The user asks for 声明式部署 / 配置式部署 / "deploy from cloudbaserc" / "deploy the whole project".
- The user wants to preview what a deploy will change before applying (dry-run plan).
- The user wants to build the static hosting artifact locally first (declarative
hosting deploys no longer build implicitly — see
deployBuild). - Multi-environment deploy: production/staging via
mode+envOverrides.
Do NOT use for
- Deploying a single cloud function or one static site via
tcbCLI →../cloudbase-cli/SKILL.md. - In-app SDK integration (web/miniprogram/node) → the matching SDK skill.
- Console UI operations.
Cloud mode: deploy through the two-step upload channel
deployBuild / deployPlan / deployApply in this skill are the local-form declarative
executor. In cloud-hosted MCP mode they are intentionally not registered, because that
runtime has no local cwd and no filesystem-bound execution path.
This is an execution-channel switch, not a capability gap. Everything still deploys, but the artifact is uploaded first and the build runs in the cloud. If those three tools are missing from the tool list, that is expected — pick the channel that matches the resource.
Cloud functions — two-phase zip
queryFunctions(action=getFunctionUploadUrl, functionName?)returnsuploadUrl,uploadHeaders,cosBucketName,cosBucketRegion,cosObjectName,expiresInSecondsPUTthe function zip touploadUrlwithuploadHeadersmanageFunctions(action=createFunction|updateFunctionCode, code={cosBucketName, cosObjectName, cosBucketRegion?})— phase B deploys from the environment's own COS bucket (deployMode=cos); pass the triple through unchanged, the schema is strict
contentPath (a local directory) is rejected in cloud mode. For layer contents use
base64Content; for code use the two-phase path above.
CloudApp — two-step upload plus a cloud pipeline
queryApps(action=getUploadUrl, serviceName=...)returnsuploadUrl,uploadHeaders,unixTimestamp- Upload the source/build zip to
uploadUrlwith the returned headers (Content-Type: application/zip)- Public dependencies resolvable from a lockfile:
package.jsonplus lockfile is enough - Private or offline dependencies: package
node_modulesexplicitly
- Public dependencies resolvable from a lockfile:
manageApps(action=deployApp, cosTimestamp=<unixTimestamp>, installCmd?, buildCmd?, deployCmd?)installCmd/buildCmd/deployCmdare pipeline declarations executed in the cloud container; you pass data and declarations, you do not run local shell commands
Static hosting — route through CloudApp
manageHosting(action=upload) is blocked in cloud mode because it needs a local path.
Deploy a static site through the CloudApp two-step upload above (upload the prebuilt
artifact, exclude node_modules). Uploading or downloading an already-hosted file has no
remote substitute and needs local mode. The other hosting actions (delete,
setWebsiteDocument, enableService, bindDomain, unbindDomain, updateDomain) remain
available.
What cloud mode does not give you
- No dry-run. There is no
deployPlanagainst a localcloudbaserc. Do not claim a plan was generated or reviewed in cloud mode; state what is about to be deployed and what the upload contains. Roadmap: uploadcloudbasercas a data artifact, then run server-side plan/apply orchestration. - No local project context.
mode/envOverridesresolution from a project file does not apply; pass the target environment explicitly.
For parameter details, see references/plan-and-apply.md (Cloud-hosted upload pipeline path).
Core principles
-
Plan before apply — always. Run
deployPlanfirst (dry-run, zero side effects). Read the per-resource action classification and show it to the user before callingdeployApply. -
Apply requires explicit confirm.
deployApplywill refuse unlessconfirm=trueis passed. This is the destructive-write guard. -
Deployment Gate. Before any apply, complete
cloudbase-platform/references/protocols/deployment-gate.mdand present the mandatory declaration. -
Conservative on existing resources by default.
yesdefaults tofalse→ existing resources are skipped, not overwritten. Only passyes=truewhen the user explicitly wants to overwrite/update existing resources. -
database failure always aborts. Even with
continueOnError=true, a database-stage failure stops the whole deploy, because later resources depend on it. -
Resolve envId explicitly. Never rely on implicit defaults silently — know which environment is targeted (see the priority table below) and confirm it with the user before applying.
Plan action classification
deployPlan returns a list of resource entries. Each status means:
| status | meaning |
|---|---|
create |
new resource, will be created |
update |
exists, will be overwritten/updated |
skip |
no change needed |
conflict |
conflict detected — deploy will abort, must resolve first |
deploy |
direct overwrite upload |
If any entry is conflict, stop and resolve it before applying.
envId resolution priority
explicit envId param > cloudbaserc `envId` > logged-in / bound environment
If none can be resolved, the tool errors out. Prefer confirming the resolved envId with the user before applying to production.
Local workflow (build → plan → apply)
When app or hosting needs built artifacts, declarative deploy is a three-step flow —
deployApply runs no build for either resource type:
- Ensure a
cloudbasercconfig exists under the project root (cwd). - Build first. Which executor depends on the resource:
hostingwith abuildCommand: calldeployBuild({ cwd, mode? })to produce the local artifacts (builds every hosting item; pure-static items without a build command are skipped automatically).app: build it yourself in the project directory —deployBuilddoes not coverapp. RundeployPlanfirst and usebuildHint.buildCommand/buildHint.outputDirto know what to run and where the artifacts must land.- If the build artifacts are missing at apply time,
deployApplyfails withBUILD_OUTPUT_NOT_FOUNDand directs you back to this step. deployBuildneeds noenvIdand noconfirm(local build only, never touches cloud resources); if dependencies are not installed it fails withDEPENDENCY_NOT_INSTALLEDand tells you to run install first.
- Call
deployPlan(optionally withmode,envId,only,skip). Read the plan, and checkbuildHint.artifactReadyon everyapp/hostingitem. - Present the plan + Deployment Gate declaration to the user; get confirmation.
- Call
deployApplywithconfirm=true(plusyes/concurrency/continueOnErroras needed). Reuse the samemode/envId/only/skipas the plan. A hosting item with existing build output is uploaded directly (the tool clears the build command and reportshostingNeutralized: true); rebuild after source changes so the upload is not stale. - Report the applied result back to the user.
For cloud-hosted MCP mode, do not ask for local cwd/filesystem reads; use the
Cloud mode upload-channel flow above.
Build & pipeline execution
Use this mental model: build → plan → apply. The build executor depends on resource type.
deployApply never runs a build — neither for app nor for hosting. buildCommand /
installCommand / framework in cloudbaserc are only used to infer the output
directory; they are never executed by apply.
| resource | typical build executor | deployment path |
|---|---|---|
hosting |
deployBuild (local shell build, run before apply) |
deployApply uploads the built output directly; missing output → BUILD_OUTPUT_NOT_FOUND |
app |
you build it — run the build in the project directory before apply (deployBuild does not cover app) |
deployApply uploads outputDir as-is; missing/empty → BUILD_OUTPUT_NOT_FOUND |
app via cloud pipeline |
CLI tcb app deploy (source zip + cloud build) |
not reachable through deployApply — use the CLI when a cloud build is wanted |
functions |
local zip / cloud build / image pipeline | depends on buildStrategy (zip/cloud/local/image) |
Reading the build context from deployPlan
app and hosting plan items carry a machine-readable buildHint:
"buildHint": {
"buildCommand": "npm run build", // null → nothing to build
"outputDir": "/abs/path/to/dist", // what apply will upload
"artifactReady": false // false → apply will fail
}
Read these fields instead of parsing the localized text in details. When
artifactReady is false: run deployBuild for hosting, or execute
buildHint.buildCommand in the project directory for app; then re-run deployPlan
and confirm artifactReady: true. Never edit the config to work around it.
deployBuild builds every hosting item that has a buildCommand (framework mapping or
package.json auto-detection); it skips pure-static items and does not touch app.
Build failures surface as BUILD_FAILED, missing local dependencies as
DEPENDENCY_NOT_INSTALLED (run install first — deployBuild never installs
dependencies for you).
Build command resolution follows declaration priority:
explicit config > framework mapping defaults > package.json auto-detection
buildCommand / installCommand / deployCmd are declarative intent in config.
Execution ownership depends on path:
- local-form paths: specific steps may run in local shell executor
- cloud-hosted paths: commands are executed by cloud pipeline container (staticCmd), or replaced by prebuilt artifact upload
So the answer to "can cloud mode run local CLI commands" is: execution authority is moved from local shell to cloud pipeline; agent transmits declarations and artifacts.
Routing
| User task | Read |
|---|---|
| cloudbaserc resource fields & desired-state config shape | references/config-schema.md |
| deployPlan → deployApply two-step flow, parameters, safety | references/plan-and-apply.md |
| Multi-env (mode / envOverrides), envId priority, env vars | references/multi-env.md |
Minimum self-check
- Built the hosting artifacts first (
deployBuild) whenhostingdeclares abuildCommand? - Built the
appartifacts yourself (deployBuilddoes not coverapp) and confirmedbuildHint.artifactReady: truein the plan? - Ran
deployPlanand read the action classification beforedeployApply? - Resolved and confirmed the target
envId? - Completed the Deployment Gate declaration before applying?
- Passed
confirm=trueonly after user confirmation? - Left
yes=falseunless overwrite of existing resources was explicitly requested? - Handled any
conflictentries before applying?
Reference index
All packaged reference files (required for skill lint reachability):
このスキルのファイル
5cloudbase-declarative-deploy skillに関する質問
Claude Codeにcloudbase-declarative-deploy skillをインストールするには
npx degit TencentCloudBase/CloudBase-AI-Toolkit/config/.claude/skills/cloudbase-declarative-deploy ~/.claude/skills/cloudbase-declarative-deployを実行してください。Claude Codeは~/.claude/skills(すべてのプロジェクト)または.claude/skills(単一プロジェクト)からskillsを読み込み、説明がタスクに一致する場合にskillを使用します。
cloudbase-declarative-deploy skillはどのクライアントで使用できますか
Agent Skills形式を読み込むすべてのクライアントで使用できます: Claude Code、Codex、Gemini CLI、claude.ai(ZIPとしてアップロード)。skill内のスクリプトは、クライアントがコード実行を許可した場合にのみ実行されます。
CloudBaseリソースのデプロイ順序はどのようになりますか?
オーケストレーターは、データベース、関数、アプリ、ホスティング、ゲートウェイの順に、固定された依存関係に従ってリソースを適用します。
デプロイを適用する前にドライランを実行できますか?
はい、deployApplyを呼び出す前に、deployPlanツールを使用してドライランを実行し、変更内容をプレビューすることをお勧めします。
deployApplyはアプリケーションやホスティングのアーティファクトを自動的にビルドしますか?
いいえ、deployApplyはアプリやホスティングリソースのビルドを実行しません。事前にdeployBuildまたはローカルコマンドを使用してビルドしておく必要があります。