example

示例命令

这是一个示例命令，用于演示如何为 Spec Kit 扩展创建命令。

用途

描述此命令的作用以及适用场景。

先决条件

列出使用此命令前的要求：

1. 先决条件 1（例如 “MCP server configured”）
2. 先决条件 2（例如 “Configuration file exists”）
3. 先决条件 3（例如 “Valid API credentials”）

用户输入

$ARGUMENTS

步骤

步骤 1：加载配置

从项目中加载扩展配置：

config_file=".specify/extensions/my-extension/my-extension-config.yml"

if [ ! -f "$config_file" ]; then
  echo "❌ Error: Configuration not found at $config_file"
  echo "Run 'specify-cn extension add my-extension' to install and configure"
  exit 1
fi

# Read configuration values
setting_value=$(yq eval '.settings.key' "$config_file")

# Apply environment variable overrides
setting_value="${SPECKIT_MY_EXTENSION_KEY:-$setting_value}"

# Validate configuration
if [ -z "$setting_value" ]; then
  echo "❌ Error: Configuration value not set"
  echo "Edit $config_file and set 'settings.key'"
  exit 1
fi

echo "📋 Configuration loaded: $setting_value"

步骤 2：执行主要操作

描述此步骤要做什么：

使用 MCP 工具执行主要操作：

• Tool: example-mcp-server example_tool
• Parameters: { "key": "$setting_value" }

这会调用 MCP server 工具来执行操作。

步骤 3：处理结果

处理结果并输出：

echo ""
echo "✅ Command completed successfully!"
echo ""
echo "Results:"
echo "  • Item 1: Value"
echo "  • Item 2: Value"
echo ""

步骤 4：保存输出（可选）

如果需要将结果保存到文件：

output_file=".specify/my-extension-output.json"

cat > "$output_file" <<EOF
{
  "timestamp": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
  "setting": "$setting_value",
  "results": []
}
EOF

echo "💾 Output saved to $output_file"

配置参考

此命令使用 my-extension-config.yml 中的以下配置：

• settings.key: 此设置的用途说明

  • Type: string
  • Required: Yes
  • Example: "example-value"

• settings.another_key: 另一个设置的说明

  • Type: boolean
  • Required: No
  • Default: false
  • Example: true

环境变量

可以使用环境变量覆盖配置：

• SPECKIT_MY_EXTENSION_KEY - 覆盖 settings.key
• SPECKIT_MY_EXTENSION_ANOTHER_KEY - 覆盖 settings.another_key