adding-cli-commands

스타16

포크0

업데이트2026년 4월 1일 09:36

Add new CLI commands to clawctl. Use when creating a new command, subcommand group, or modifying the CLI surface. Ensures all touchpoints are updated: handler, exports, commander wiring, README, shell completions, and tests.

설치

Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.

출처

TimBeyer

TimBeyer/clawctl

GitHub 저장소 열기 Creator 저장소 보기

다운로드

Adding CLI Commands

When adding a new command to clawctl, 7 places need updating. Missing any of them causes broken completions, missing docs, or test failures.

Checklist

Command handler — packages/cli/src/commands/<name>.ts Create export async function runCommandName(...). For instance-targeting commands, use requireInstance(opts).
Barrel export — packages/cli/src/commands/index.ts Add export { runCommandName } from "./<name>.js"
Commander wiring — packages/cli/bin/cli.tsx Add .command() block with description, options, action handler. Import the handler from the barrel export.
README — README.md (commands table, around line 66) Add a row with command syntax and description.
Bash completions — packages/templates/src/completions/bash.ts
- Add to local commands="..." string (line 88)
- Add case in case "$cmd" in block with command-specific options
Zsh completions — packages/templates/src/completions/zsh.ts
- Add to commands=(...) array (around line 70)
- Add case in case ${words[1]} in block with _arguments
Completion tests — packages/templates/src/completions/completions.test.ts Add to ALL_COMMANDS array (line 6)

Conventions

See references/cli-conventions.md for instance resolution, positional argument rules, and subcommand patterns.

Subcommand groups

Parent commands like mount and daemon need special handling:

Commander: Create parent with .command("name"), add .action(() => cmd.help()) for bare invocation, nest children under it
Completions: Add the parent to the top-level commands list. Add a case that completes subcommand names. Add nested cases for each subcommand's options.
README: List each subcommand as its own row
Tests: Add the parent command name to ALL_COMMANDS

Update check skip list

If the command shouldn't trigger the auto-update check (infrastructure commands like update, daemon, completions), add it to SKIP_UPDATE_COMMANDS in cli.tsx.

이 저장소의 다른 Skills

같은 저장소

developing-vm-cli

TimBeyer/clawctl

Develop the guest CLI (claw) that runs inside the VM. Use when working on vm-cli commands, the JSON output protocol, doctor checks, CapabilityContext implementation, or the capability registry.

2026-04-0116

extending-capabilities

TimBeyer/clawctl

Write and extend VM provisioning capabilities for clawctl. Use when adding new tools to the VM, modifying the provisioning pipeline, writing CapabilityDef modules, or working with lifecycle hooks and CapabilityContext SDK.

2026-04-0116

managing-provisioning

TimBeyer/clawctl

Understand and modify the VM provisioning workflow. Use when working on the host-side provisioning sequence, understanding what each phase installs, debugging provisioning failures, or modifying the idempotency/verification flow.

2026-04-0116

understanding-architecture

TimBeyer/clawctl

Understand clawctl's architecture and design decisions. Use when exploring the codebase structure, understanding package responsibilities, learning about the VM backend, mount system, onboarding flow, or making cross-cutting changes.

2026-04-0116

name	adding-cli-commands
description	Add new CLI commands to clawctl. Use when creating a new command, subcommand group, or modifying the CLI surface. Ensures all touchpoints are updated: handler, exports, commander wiring, README, shell completions, and tests.

Adding CLI Commands

When adding a new command to clawctl, 7 places need updating. Missing any of them causes broken completions, missing docs, or test failures.

Checklist

Command handler — packages/cli/src/commands/<name>.ts Create export async function runCommandName(...). For instance-targeting commands, use requireInstance(opts).
Barrel export — packages/cli/src/commands/index.ts Add export { runCommandName } from "./<name>.js"
Commander wiring — packages/cli/bin/cli.tsx Add .command() block with description, options, action handler. Import the handler from the barrel export.
README — README.md (commands table, around line 66) Add a row with command syntax and description.
Bash completions — packages/templates/src/completions/bash.ts
- Add to local commands="..." string (line 88)
- Add case in case "$cmd" in block with command-specific options
Zsh completions — packages/templates/src/completions/zsh.ts
- Add to commands=(...) array (around line 70)
- Add case in case ${words[1]} in block with _arguments
Completion tests — packages/templates/src/completions/completions.test.ts Add to ALL_COMMANDS array (line 6)

Conventions

See references/cli-conventions.md for instance resolution, positional argument rules, and subcommand patterns.

Subcommand groups

Parent commands like mount and daemon need special handling:

Commander: Create parent with .command("name"), add .action(() => cmd.help()) for bare invocation, nest children under it
Completions: Add the parent to the top-level commands list. Add a case that completes subcommand names. Add nested cases for each subcommand's options.
README: List each subcommand as its own row
Tests: Add the parent command name to ALL_COMMANDS

Update check skip list

If the command shouldn't trigger the auto-update check (infrastructure commands like update, daemon, completions), add it to SKIP_UPDATE_COMMANDS in cli.tsx.