carapace-dev

Reference Carapace library internals for debugging and feature development across Action API and traverse engine.

1.4k|36|Updated Mar 17, 2020
One-click install
npx skills add https://github.com/carapace-sh/carapace --skill carapace-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: carapace-dev
Source: https://github.com/carapace-sh/carapace/tree/main/skills/carapace-dev
Command: npx skills add https://github.com/carapace-sh/carapace --skill carapace-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive reference for developing or debugging the carapace library, covering the Action API, traverse engine, shell formatters, style system, pflag extensions, and internal implementation details.

Core Features & Use Cases

  • Action API overview and modifiers
  • Traverse engine, Batch, and storage concepts
  • Shell integration, style system, and pflag extensions
  • Sandbox/testing and bridge patterns

Quick Start

Open the Carapace development reference and start with reading the Action API and traverse references to begin debugging.

Frequently Asked Questions about carapace-dev

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the carapace Action API and how does it handle shell completion logic?

The traverse engine in carapace processes completion requests by navigating command structures and resolving arguments. It coordinates with storage and batch concepts to manage state during traversal operations.

How do I use pflag extensions when debugging carapace shell integration?

Carapace pflag extensions enhance standard flag parsing with completion-aware metadata. The reference covers how these extensions integrate with the style system to format output for different shell environments.

Does carapace support sandboxing and caching during action development?

Yes, carapace includes sandboxing for testing actions in isolated environments and caching mechanisms to store completion results. The reference documents how to properly implement these patterns when developing features.

What are the limitations of the carapace style system when exporting completions?

The carapace style system formats completions for specific shells but is constrained by each shell's native capabilities. The export format must align with target shell specifications, limiting cross-shell style portability.

When should I use bridge patterns in carapace action development?

Bridge patterns in carapace connect external completion sources into the native Action API. Use them when integrating existing completion definitions or wrapping third-party tools that require traversal translation.