carapace-sh/carapace-bin / skills/carapace
carapace
VerifiedUse when working with carapace shell completion — integrating into CLIs, writing YAML specs, creating custom actions, building completion-aware lexers for DSLs, looking up macros, setting up shell completion, configuring choices/bridges, using the MCP server, or adding man page documentation.
Carapace Usage Reference
Reference for using carapace shell completion — integrating into CLIs, writing specs, creating actions, and configuring completions.
Sub-Resources
Load the reference that matches your task. When in doubt, load multiple references.
| Keywords | Reference |
|---|---|
| Integrate carapace, cobra, PreRun, PreInvoke, bridge, standalone mode, flag config, non-POSIX flags | references/integrate.md |
| Effective actions, ActionValues, ActionCallback, ActionExecCommand, modifiers, naming, caching, batch, MultiParts, UID, tags, linting, carapace:curated | references/action.md |
| YAML spec, user spec, flags, subcommands, parsing modes, exclusiveflags, aliases, completion, macros, modifiers, runnable specs | references/spec.md |
| Macro format, MacroN, MacroI, MacroV, $files, macro signatures, modifier chaining | references/macro.md |
| Choices, variants, bridges, CARAPACE_BRIDGES, --choice, --list, group priority | references/choice.md |
| Setup, shell integration, environment variables, overlays, extensions, install | references/setup.md |
| Environment variable completion, env YAML, conditions, ActionNames, ActionValues | references/env.md |
| Convert spec to Go, codegen, macro-to-Go mapping, modifier translation | references/convert.md |
| Update existing completer, incremental update, new flags, new subcommands, surgical edits | references/update.md |
| Scrape spec, generate from source, Docker, supported frameworks, patch-and-container | references/scrape.md |
| MCP server, complete tool, list_macros tool, codegen tool, JSON-RPC, stdio transport | references/mcp.md |
| Man pages, carapace-man, UID documentation, YAML man pages, inline descriptions, scheme, host, path | references/man.md |
| Lexer, parser, DSL completion, CompletionContext, ParseForCompletion, grammar package, completion-aware parser, argstream | references/lexer.md |
Quick Guide
- How do I add carapace to my cobra CLI? → references/integrate.md
- How do I create a custom completion action? → references/action.md
- How do I write a YAML user spec? → references/spec.md
- How do I format macro arguments? → references/macro.md
- How do completers/bridges/choices work? → references/choice.md
- How do I set up shell completion? → references/setup.md
- How do I add environment variable completions? → references/env.md
- How do I convert a spec to a native Go completer? → references/convert.md
- How do I update an existing completer for a new CLI version? → references/update.md
- How do I generate a spec from CLI source code? → references/scrape.md
- How do I use the MCP server? → references/mcp.md
- How do I add inline documentation for completion values? → references/man.md
- How do I build a lexer for a DSL value? → references/lexer.md
Cross-Project References
For internal library development (Action API internals, traverse engine, shell formatters, style system), use the carapace-dev skill (in the carapace repo).
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |