mcpField
W
working-with-claude-code

working-with-claude-code

github.com/obraAgent 工作流146200 次安装47 周前更新
代码仓库

关于 working-with-claude-code

这是一项从 docs.claude.com 提供 Claude Code 文档的参考技能,供开发者查询配置、插件、MCP、钩子、技能、命令行、集成和故障排查的官方说明。

主要功能

  1. 01Claude Code 官方文档
  2. 02按主题组织的 Markdown 参考
  3. 03插件与技能指南
  4. 04配置和命令行参考
  5. 05文档更新脚本

适用场景

  1. 01查询 Claude Code 设置
  2. 02查看 MCP 服务配置步骤
  3. 03查找插件、钩子或技能说明
  4. 04排查 Claude Code 问题

MCP 相关

包含 MCP 服务配置参考文档;该技能本身不提供 MCP 服务。

安装

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

$npx skills add https://github.com/obra/superpowers-developing-for-claude-code --skill working-with-claude-code

安装后在 Claude Code 中输入/working-with-claude-code确认已加载。

包含的文件

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

references/
amazon-bedrock.md
analytics.md
checkpointing.md
cli-reference.md
common-workflows.md
costs.md
data-usage.md
devcontainer.md
github-actions.md
gitlab-ci-cd.md
google-vertex-ai.md
headless.md
hooks-guide.md
hooks.md
iam.md
interactive-mode.md
jetbrains.md
legal-and-compliance.md
llm-gateway.md
mcp.md
memory.md
migration-guide.md
model-config.md
monitoring-usage.md
network-config.md
output-styles.md
overview.md
plugin-marketplaces.md
plugins-reference.md
plugins.md

详细介绍

使用 Claude Code

概述

此技能直接提供来自 docs.claude.com 的 Claude Code 完整权威文档。无需猜测配置路径、API 结构或功能能力,只需阅读此技能的 references 目录中存储的官方文档。

何时使用

在以下情况下使用此技能:

  • 创建或配置 Claude Code 插件
  • 设置 MCP 服务
  • 使用钩子(提交前、会话启动等)
  • 编写或测试技能
  • 配置 Claude Code 设置
  • 排查 Claude Code 问题
  • 了解 CLI 命令
  • 设置集成(VS Code、JetBrains 等)
  • 配置网络、安全或企业功能

快速参考

任务阅读此文件
创建插件plugins.md,然后阅读 plugins-reference.md
设置 MCP 服务mcp.md
配置钩子hooks.md,然后阅读 hooks-guide.md
编写技能skills.md
CLI 命令cli-reference.md
排查问题troubleshooting.md
常规设置setup.md 或 quickstart.md
配置选项settings.md

文档组织方式

所有文档都以独立的 Markdown 文件形式存储在 references/ 中。使用 Read 工具访问特定文档:

references/
├── overview.md              # Claude Code introduction
├── quickstart.md           # Getting started guide
├── setup.md                # Installation and setup
├── plugins.md              # Plugin development
├── plugins-reference.md    # Plugin API reference
├── plugin-marketplaces.md  # Plugin marketplaces
├── skills.md               # Skill creation
├── mcp.md                  # MCP server integration
├── hooks.md                # Hooks overview
├── hooks-guide.md          # Hooks implementation guide
├── slash-commands.md       # Slash command reference
├── sub-agents.md           # Subagent usage
├── settings.md             # Configuration reference
├── cli-reference.md        # CLI command reference
├── common-workflows.md     # Common usage patterns
├── interactive-mode.md     # Interactive mode guide
├── headless.md             # Headless mode guide
├── output-styles.md        # Output customization
├── statusline.md           # Status line configuration
├── memory.md               # Memory and context management
├── checkpointing.md        # Checkpointing feature
├── analytics.md            # Usage analytics
├── costs.md                # Cost tracking
├── monitoring-usage.md     # Usage monitoring
├── data-usage.md           # Data usage policies
├── security.md             # Security features
├── iam.md                  # IAM integration
├── network-config.md       # Network configuration
├── terminal-config.md      # Terminal configuration
├── model-config.md         # Model configuration
├── llm-gateway.md          # LLM gateway setup
├── amazon-bedrock.md       # AWS Bedrock integration
├── google-vertex-ai.md     # Google Vertex AI integration
├── vs-code.md              # VS Code integration
├── jetbrains.md            # JetBrains integration
├── devcontainer.md         # Dev container support
├── github-actions.md       # GitHub Actions integration
├── gitlab-ci-cd.md         # GitLab CI/CD integration
├── third-party-integrations.md  # Other integrations
├── legal-and-compliance.md # Legal information
├── troubleshooting.md      # Troubleshooting guide
└── migration-guide.md      # Migration guide

工作流

针对具体问题
  1. 从上方列表中确定相关文档文件
  2. 使用 Read 工具加载:@references/filename.md
  3. 在官方文档中查找答案
  4. 应用解决方案

示例:

User: "How do I create a Claude Code plugin?"
→ Read @references/plugins.md
→ Follow the official plugin creation steps
针对宽泛主题

探索某个主题时,先从概览文档入手,再深入查看具体文件:

  • 扩展 Claude Code:从 plugins.md、skills.md 或 mcp.md 开始
  • 配置:从 settings.md 或 setup.md 开始
  • 集成:查看相关的集成文件(vs-code.md、github-actions.md 等)
  • 故障排查:从 troubleshooting.md 开始
针对不确定的主题

使用 Grep 工具搜索所有文档:

pattern: "search term"
path: ~/.claude/skills/working-with-claude-code/references/

更新文档

此技能包含 scripts/update_docs.js,用于从 docs.claude.com 获取最新文档。

在以下情况下运行:

  • 文档似乎已过时
  • 发布了 Claude Code 新功能
  • 官方文档已更新
node ~/.claude/skills/working-with-claude-code/scripts/update_docs.js

该脚本会:

  1. 从 docs.claude.com 获取 llms.txt
  2. 提取所有 Claude Code 文档 URL
  3. 将每个页面下载到 references/
  4. 报告成功或失败的情况

常见模式

插件开发

阅读 plugins.md 了解概述,然后阅读 plugins-reference.md 了解 API 详情。

MCP 服务设置

阅读 mcp.md 了解配置格式和示例。

钩子配置

阅读 hooks.md 了解概述,然后阅读 hooks-guide.md 了解实现细节。

技能创建

阅读 skills.md 获取完整的技能编写指南。

此技能不提供什么

  • 此技能提供的是文档访问,而非操作指导
  • 若要了解如何构建插件/技能的工作流,请使用 extending-claude-code 技能(如有)
  • 此技能是一个参考资料库,而非教程

警示信号

如果你发现自己在:

  • 猜测配置文件的位置 → 阅读 settings.md
  • 推测 API 结构 → 阅读相关参考文档
  • 不确定钩子名称 → 阅读 hooks.md
  • 对功能作出假设 → 先搜索文档

始终先查阅官方文档,再进行猜测。

评论

支持 Markdown