skill-cookiecutterproject-slug

dnvriend's avatarfrom dnvriend

{{cookiecutter.project_description}}

⭐0stars🔀0forks📁View on GitHub🕐Updated Nov 20, 2025
[Developer Tools]

When & Why to Use This Skill

This Claude skill integrates a robust CLI tool framework into the agent's environment, enabling seamless command-line automation and technical workflow management. It is designed to bridge the gap between AI agents and local terminal operations, providing structured access to CLI commands, advanced logging, and pipeline integration to enhance developer productivity and system automation.

Use Cases

  • Terminal Workflow Automation: Execute complex command-line operations and multi-step scripts directly through Claude to minimize context switching during development.
  • DevOps Pipeline Integration: Leverage the tool's JSON output and shell completion features to build automated deployment or monitoring pipelines.
  • Technical Troubleshooting & Debugging: Utilize progressive verbosity levels (INFO/DEBUG/TRACE) and structured exit codes to diagnose system issues and verify environment configurations.
nameskill-{{cookiecutter.project_slug}}
description{{cookiecutter.project_description}}

When to use

  • When you need to use {{cookiecutter.project_slug}} CLI tool
  • When you need comprehensive guidance on CLI commands
  • When you need examples and troubleshooting

{{cookiecutter.project_name}} Skill

Purpose

This skill provides access to the {{cookiecutter.project_slug}} CLI tool. {{cookiecutter.project_description}}.

When to Use This Skill

Use this skill when:

  • You need to understand how to use {{cookiecutter.project_slug}}
  • You need comprehensive examples and patterns
  • You need troubleshooting guidance

Do NOT use this skill for:

  • Tasks unrelated to {{cookiecutter.project_slug}}
  • Quick syntax lookups (use slash commands instead)

CLI Tool: {{cookiecutter.project_slug}}

The {{cookiecutter.project_slug}} is a command-line interface tool that {{cookiecutter.project_description}}.

Installation

# Clone and install
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.git
cd {{cookiecutter.project_slug}}
uv tool install .

Prerequisites

  • Python 3.14+
  • uv package manager

Quick Start

# Example 1: Basic usage
{{cookiecutter.project_slug}} --help

# Example 2: Show version
{{cookiecutter.project_slug}} --version

Progressive Disclosure

📖 Core Commands (Click to expand)

help - Show Help Information

Display help information for CLI commands.

Usage:

{{cookiecutter.project_slug}} --help
{{cookiecutter.project_slug}} COMMAND --help

Examples:

# General help
{{cookiecutter.project_slug}} --help

# Command help
{{cookiecutter.project_slug}} command --help

# Version info
{{cookiecutter.project_slug}} --version
⚙️ Advanced Features (Click to expand)

Multi-Level Verbosity Logging

Control logging detail with progressive verbosity levels. All logs output to stderr.

Logging Levels:

Flag Level Output Use Case
(none) WARNING Errors and warnings only Production, quiet mode
-v INFO + High-level operations Normal debugging
-vv DEBUG + Detailed info, full tracebacks Development, troubleshooting
-vvv TRACE + Library internals Deep debugging

Examples:

# INFO level - see operations
{{cookiecutter.project_slug}} command -v

# DEBUG level - see detailed info
{{cookiecutter.project_slug}} command -vv

# TRACE level - see all internals
{{cookiecutter.project_slug}} command -vvv

Shell Completion

Native shell completion for bash, zsh, and fish.

Installation:

# Bash (add to ~/.bashrc)
eval "$({{cookiecutter.project_slug}} completion bash)"

# Zsh (add to ~/.zshrc)
eval "$({{cookiecutter.project_slug}} completion zsh)"

# Fish (save to completions)
{{cookiecutter.project_slug}} completion fish > ~/.config/fish/completions/{{cookiecutter.project_slug}}.fish

Pipeline Composition

Compose commands with Unix pipes for powerful workflows.

Examples:

# Example pipeline workflows will be added when CLI commands are implemented
{{cookiecutter.project_slug}} command --json | jq '.'
🔧 Troubleshooting (Click to expand)

Common Issues

Issue: Command not found

# Verify installation
{{cookiecutter.project_slug}} --version

# Reinstall if needed
cd {{cookiecutter.project_slug}}
uv tool install . --reinstall

Issue: General errors

  • Try with verbose flag: -vv to see detailed error information
  • Check that all prerequisites are installed
  • Ensure you're using Python 3.14+

Getting Help

# Show help
{{cookiecutter.project_slug}} --help

# Command-specific help
{{cookiecutter.project_slug}} COMMAND --help

Exit Codes

  • 0: Success
  • 1: Client error (invalid arguments, validation failed)
  • 2: Server error (API error, network issue)
  • 3: Network error (connection failed, timeout)

Output Formats

Default Output:

  • Human-readable formatted output
  • Varies by command

JSON Output (--json flag):

  • Machine-readable structured data
  • Perfect for pipelines and processing
  • Available on commands that support structured output

Best Practices

  1. Use verbosity progressively: Start with -v, increase to -vv/-vvv only if needed
  2. Check help first: Use --help to understand command options
  3. Leverage shell completion: Install completion for better CLI experience

Resources