cli-tool-design
Skill17 starsChanged 5 months agoApache-2.0Archived repositoryView on GitHub
Design command-line interfaces with clear argument parsing, subcommands, help text, output formatting, and exit codes. Covers Click, Typer, argparse, and shell completion. Triggers on CLI tool development, argument parsing, or terminal UX design requests.
1 other project uses a version of this.
Other versions1 project uses a version of this.
Word for word · 1
- organvm-iv-taxis/a-i--skills★ 17100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository170 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- algorithmic-artSkill
- audio-engineering-patternsSkill
- canvas-designSkill
- creative-writing-craftSkill
- generative-art-algorithmsSkill
- generative-art-deploymentSkill
- generative-music-composerSkill
- interactive-theatre-designerSkill
- modular-synthesis-philosophySkill
- movement-notation-systemsSkill
- narratological-algorithmsSkill
- natural-center-extractionSkill
- react-three-fiber-patternsSkill
- reality-tv-narrative-analyzerSkill
- script-analysis-dramaturgicalSkill
- theme-factorySkill
- three-js-interactive-builderSkill
- corpus-persona-extractionSkill
- data-ingestion-pipelineSkill
- data-pipeline-architectSkill
- data-storytelling-analystSkill
- market-gap-analysisSkill
- ml-experiment-trackerSkill
- prompt-atom-formalizationSkill
- sql-query-optimizerSkill
- systemic-product-analystSkill
- time-series-analystSkill
- accessibility-patternsSkill
- agent-testing-patternsSkill
- api-design-patternsSkill
- artifacts-builderSkill
- backend-implementation-patternsSkill
- browser-extension-patternsSkill
- code-refactoring-patternsSkill
- code-review-checklistSkill
- coding-standards-enforcerSkill
- community-platform-patternsSkill
- configuration-managementSkill
- continuous-learning-agentSkill
- data-backup-patternsSkill
- database-migration-patternsSkill
- deployment-cicdSkill
- docker-containerizationSkill
- dotfile-systems-architectSkill
- error-handling-logging-patternsSkill
- fastapi-patternsSkill
- feature-workflow-orchestratorSkill
- frontend-design-systemsSkill
- fullstack-starter-packSkill
- gcp-resource-optimizerSkill
- htmx-interaction-patternsSkill
- iterative-code-explorationSkill
- json-schema-designSkill
- mcp-builderSkill
- mcp-server-orchestratorSkill
- mobile-platform-architectSkill
- The first 60 shown.
The file
Files
CLI Tool Design
Build command-line tools that are discoverable, composable, and pleasant to use.
Design Principles
The UNIX Philosophy Applied
- Do one thing well — Each command has a clear, singular purpose
- Compose through pipes — Support stdin/stdout for chaining
- Fail loudly — Non-zero exit codes and stderr for errors
- Be predictable — Consistent flags, consistent output format
Command Structure
program [global-options] command [command-options] [arguments]Example:
organvm --verbose registry update --organ IV a-i--skillsFramework Selection
| Framework | Language | Best For |
| Typer | Python | Modern CLIs with type hints, auto-completion |
| Click | Python | Complex CLIs, plugins, nested groups |
| argparse | Python | Zero-dependency, stdlib-only |
| clap | Rust | High-performance, compiled CLIs |
| cobra | Go | Go microservice CLIs |
Building with Typer (Recommended for Python)
Basic Command
import typer
app = typer.Typer(help="ORGANVM system management CLI")
@app.command()
def status(
organ: str = typer.Argument(help="Organ number (I-VII or META)"),
verbose: bool = typer.Option(False, "--verbose", "-v", help="Show detailed output"),
):
"""Show the status of an organ's repositories."""
# Implementation hereSubcommand Groups
app = typer.Typer()
registry_app = typer.Typer(help="Registry operations")
app.add_typer(registry_app, name="registry")
@registry_app.command("update")
def registry_update(
organ: str = typer.Argument(help="Target organ"),
dry_run: bool = typer.Option(False, "--dry-run", "-n"),
):
"""Update registry entries for an organ."""Rich Output Integration
from rich.console import Console
from rich.table import Table
console = Console(stderr=True) # Status to stderr
def show_repos(repos: list[dict]):
table = Table(title="Repositories")
table.add_column("Name", style="cyan")
table.add_column("Status", style="green")
table.add_column("Tier")
for repo in repos:
table.add_row(repo["name"], repo["status"], repo["tier"])
console.print(table)Argument Design
Positional vs Optional
| Use Case | Type | Example |
| Required input | Positional | program FILE |
| Behavior modifier | Flag | --verbose, --dry-run |
| Configuration | Option | --output FORMAT |
| Multiple inputs | Variadic | program FILE... |
Flag Conventions
-v, --verbose Increase output verbosity
-q, --quiet Suppress non-error output
-n, --dry-run Show what would happen without doing it
-f, --force Skip confirmation prompts
-o, --output FILE Write output to FILE instead of stdout
--json Machine-readable JSON output
--no-color Disable colored outputBoolean Flags with Negation
@app.command()
def deploy(
color: bool = typer.Option(True, "--color/--no-color"),
interactive: bool = typer.Option(True, "--interactive/--no-interactive"),
):Output Design
Human vs Machine Output
import json
import sys
def output_results(results: list[dict], json_mode: bool = False):
if json_mode:
# Machine output to stdout
json.dump(results, sys.stdout, indent=2)
else:
# Human output with formatting
for r in results:
console.print(f"[cyan]{r['name']}[/] — {r['status']}")Progress Indicators
from rich.progress import track
for item in track(items, description="Processing..."):
process(item)Stderr vs Stdout
- stdout: Data output (pipeable)
- stderr: Status messages, progress, errors
Exit Codes
| Code | Meaning |
| 0 | Success |
| 1 | General error |
| 2 | Usage error (bad arguments) |
| 64-78 | BSD sysexits conventions |
| 130 | Interrupted (Ctrl+C) |
import sys
def main():
try:
result = run_command()
if not result.success:
console.print(f"[red]Error:[/] {result.error}", file=sys.stderr)
raise SystemExit(1)
except KeyboardInterrupt:
raise SystemExit(130)Configuration Loading
Priority order (highest to lowest):
- Command-line arguments
- Environment variables
- Project-level config file (
.tool.yaml) - User-level config (
~/.config/tool/config.yaml) - System defaults
def get_config(cli_value: str | None = None) -> str:
return (
cli_value
or os.environ.get("TOOL_CONFIG")
or load_project_config()
or load_user_config()
or DEFAULT_VALUE
)Shell Completion
Typer Auto-Completion
# Generate completion script
my-cli --install-completion
# Or manually
_MY_CLI_COMPLETE=bash_source my-cli > ~/.my-cli-complete.bash
source ~/.my-cli-complete.bashCustom Completions
def complete_organ(incomplete: str) -> list[str]:
organs = ["I", "II", "III", "IV", "V", "VI", "VII", "META"]
return [o for o in organs if o.startswith(incomplete.upper())]
@app.command()
def status(organ: str = typer.Argument(autocompletion=complete_organ)):
...Testing CLIs
from typer.testing import CliRunner
runner = CliRunner()
def test_status_command():
result = runner.invoke(app, ["status", "IV"])
assert result.exit_code == 0
assert "a-i--skills" in result.stdout
def test_invalid_organ():
result = runner.invoke(app, ["status", "INVALID"])
assert result.exit_code == 2Anti-Patterns
- Requiring interactive input in scripts — Always support
--yes/--no-interactiveflags - Mixing data and status on stdout — Use stderr for progress and status messages
- Inconsistent flag naming — Pick a convention and stick to it across all subcommands
- No help text — Every command, argument, and option needs a help string
- Swallowing errors — Always exit with appropriate non-zero codes on failure
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

