Skills
.Work. You
Rest

arch-cli-contract

Community

Define and document the external CLI surface contract for a command-line tool.

Software Engineering#CLI#contract#CLI design#command-line tool#CLI documentation
AuthorVictorHueni
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps define, document, and maintain the external CLI surface contract for a command-line tool, ensuring consistency and clarity in its usage.

Core Features & Use Cases

  • CLI Contract Definition: Automates the creation of a Markdown document outlining the CLI's command tree, flags, arguments, output format, exit codes, and error contract.
  • Design Modes: Supports Scaffold, Design (contract-first), Document-existing, and Refresh modes to cater to different stages of CLI development.
  • Quality Checks: Provides a comprehensive checklist to ensure the contract meets quality standards, including proper flag usage, output separation, and exit code documentation.
  • Output Contract: Generates a Markdown document that serves as a stable contract between the tool and its users, specifying what is expected from the CLI.

Quick Start

Use the arch-cli-contract skill to generate a CLI contract for your tool 'mytool' in Scaffold mode.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: arch-cli-contract
Download link: https://github.com/VictorHueni/homemade-claude-kit/archive/main.zip#arch-cli-contract

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.