OpenParable
Skip to content
← Back to skills

Carapace Dev

Development
carapace-dev

Carapace Dev is an Agent Skill for development published in the carapace-sh/carapace repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when developing or debugging the carapace library — Action API, traverse engine, shell formatters, style system, pflag extensions, or internal implementation details. Triggers on: "carapace" (development context), "carapace Action", "carapace traverse", "carapace shell", "carapace style", "pflagfork", "carapace-bridge".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/carapace-sh/carapace/blob/HEAD/skills/carapace-dev/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/carapace-dev, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Carapace Development Reference

Reference for developing and debugging the carapace library.

Sub-Resources

Load the reference that matches your task. When in doubt, load multiple references.

KeywordsReference
Action type, modifier, InvokedAction, Context, callback, Batch, rawValues, suffix namingreferences/action.md
traverse, completion engine, argument classification, pflagfork, shell patching, complete(), dispatchreferences/traverse.md
pflag, flag mode, NameAsShorthand, ShorthandOnly, Nargs, OptargDelimiter, ArgumentStyle, non-POSIX flagsreferences/pflag.md
Shell overview, cross-shell comparison, dispatch pipeline, supported shells, nospace/message/quoting comparisonreferences/shell.md
Bash, COMP_TYPE, COMP_WORDBREAKS, redirect patching, partial completion, bash quotingreferences/shell-bash.md
Bash BLE, ble.sh, tab-delimited format, per-candidate suffix, ble/complete/cand/yieldreferences/shell-bash-ble.md
Oil, OSH, inline nospace indicator, simpler snippetreferences/shell-oil.md
Zsh, _describe, zstyle, named directory, quoting state machine, CARAPACE_COMPLINEreferences/shell-zsh.md
Fish, commandline, tab-separated format, open-quote retry, fish pagerreferences/shell-fish.md
Elvish, complexCandidate, CodeSuffix, styled, edit:notify, from-json, ParseStylingreferences/shell-elvish.md
Nushell, from json, JSON record, open-quote patching, style conversion, nushell.Patchreferences/shell-nushell.md
PowerShell, CompletionResult, Register-ArgumentCompleter, commandAst, SGR color, tooltipreferences/shell-powershell.md
Xonsh, RichCompletion, prefix_len, append_closing_quote, contextual_command_completerreferences/shell-xonsh.md
Style system, XTerm256, TrueColor, ForKeyword, ForPath, ForPathExt, LS_COLORS, style configreferences/style.md
Bridge, bridgeActions, actionCommand, output parsing, NoSpace detection, shell config, Detect()references/bridge.md
Storage, global map, mutex, entry, FlagCompletion, PositionalCompletion, PreRun, PreInvoke, storage.get, gotchasreferences/storage.md
Sandbox, Command, Package, Action, Files, Reply, Run, Expect, ExpectNot, ClearCache, SANDBOX env, subprocess isolationreferences/sandbox.md
Batch, Invoke, parallelize, Merge, ToA, invokedBatch, goroutine model, shared Context, parallel invocationreferences/batch.md
Cache, Action.Cache, File, Load, Write, cache key, file:line, key.Key types, FolderStats, TTL, sandbox overridereferences/cache.md
UID, url.URL, cmd:// scheme, Command, Flag, mLocalFlags mutex, PathEscape, Executable, UidF, uid.Mapreferences/uid.md
Config, styles.json, RegisterStyle, Load, CARAPACE_* env vars, LOG, ColorDisabled, Hidden, Sandbox, isGoRunreferences/config-env.md
Spec, spec.Spec, yaml.Marshal, Command struct, Flags, PersistentFlags, _carapace skip, pflagfork.Flag.Definitionreferences/spec.md
Export, Export struct, MarshalJSON, version, RawValue, Meta, cache format, sandbox invoke, ActionImportreferences/export.md
Conditionals, Arch, Os, Executable, File, CompletingPath, UnlessF, Context predicates, pkg/conditionreferences/conditionals.md
_carapace CLI, command.go, addCompletionCommand, spec, style set, export re-invocation, PositionalAnyCompletionreferences/command-cli.md
Mock, Mock struct, NewMock, Dir, Replies, CacheDir, WorkDir, t interface, Reply mechanism, sandbox integrationreferences/mock.md

Quick Guide

Cross-Project References

  • For user-facing topics (integrating carapace into a CLI, writing specs, macros, setup, choices), use the carapace skill (in the carapace-bin repo).
  • For in-depth bash shell knowledge (programmable completion, Readline, quoting/expansion, execution model, startup files), use the bash skill (in this repo).
  • For in-depth bash BLE/ble.sh knowledge (cand/yield, completion sources and actions, menu styles, menu-filter, progcomp integration, sabbrev, dabbrev, auto-complete, syntax highlighting, faces, gspec colors, widgets, keymaps, bleopt, ble-bind, blehook, blerc, ble-import), use the bash-ble skill (in this repo).
  • For in-depth clink/cmd.exe knowledge (argmatcher API, match generators, Readline integration, DLL injection, prompt filtering, auto-suggestions, input line coloring), use the cmd-clink skill (in this repo).
  • For in-depth elvish shell knowledge (arg-completer, complex-candidate, matcher, editor API, styled text, language fundamentals, modules, rc.elv), use the elvish skill (in this repo).
  • For in-depth xonsh shell knowledge (RichCompletion, CommandContext, contextual_command_completer, completer pipeline, prompt-toolkit integration, Python/shell hybrid model, xontribs, event system, rc.xsh), use the xonsh skill (in this repo).
  • For in-depth fish shell knowledge (complete builtin, commandline builtin, pager, autosuggestions, syntax highlighting, abbreviations, key bindings, language fundamentals, job control, startup configuration), use the fish skill (in this repo).
  • For in-depth PowerShell knowledge (Register-ArgumentCompleter, PSReadLine, CompletionResult, CommandAst, tab completion, menu completion, prediction plugins, $PSStyle ANSI rendering, quoting rules, argument passing to native commands, profiles and configuration), use the powershell skill (in this repo).
  • For in-depth tcsh shell knowledge (complete builtin, COMMAND_LINE, programmable completion, bindkey, command-line editor, quoting/expansion, execution model, startup files, addsuffix, autolist, wordchars, tenematch), use the tcsh skill (in this repo).
  • For in-depth Oil/OSH/YSH shell knowledge (programmable completion, COMP_ARGV, compadjust, compexport, OILS_COMP_UI, NiceDisplay, Readline, quoting model, simple word evaluation, lastpipe, strict:all, ysh:all, headless mode, parser-as-library, startup configuration), use the oil skill (in this repo).
  • For in-depth hilbish shell knowledge (hilbish.completions, completion handler, completion groups grid/list, TabCompleter, readline integration, Lua API, bait event system, runner mode, commander, lunacolors, syntax highlighting, hinter, vim mode, job control, init.lua configuration), use the hilbish skill (in this repo).