CRITICAL REQUIREMENTS:

Keep description in frontmatter ≤ 50 characters (hard limit)
Use progressive disclosure with tags
Include comprehensive examples in each section
Provide troubleshooting guidance
Keep always-visible content minimal (overview only)
Put detailed info in expandable sections
Use emojis for section summaries (📖 Core, ⚙️ Advanced, 🔧 Troubleshooting) -->

When to use

When you need to use paper-index-tool CLI tool
When you need comprehensive guidance on CLI commands
When you need examples and troubleshooting

paper-index-tool Skill

Purpose

This skill provides access to the paper-index-tool CLI tool. A Python CLI tool.

When to Use This Skill

Use this skill when:

You need to understand how to use paper-index-tool
You need comprehensive examples and patterns
You need troubleshooting guidance

Do NOT use this skill for:

Tasks unrelated to paper-index-tool
Quick syntax lookups (use slash commands instead)

CLI Tool: paper-index-tool

The paper-index-tool is a command-line interface tool that A Python CLI tool.

Installation

# Clone and install
git clone https://github.com/dnvriend/paper-index-tool.git
cd paper-index-tool
uv tool install .

Prerequisites

Python 3.14+
uv package manager

Quick Start

# Example 1: Basic usage
paper-index-tool --help

# Example 2: Show version
paper-index-tool --version

Progressive Disclosure

help - Show Help Information

Display help information for CLI commands.

Usage:

paper-index-tool --help
paper-index-tool COMMAND --help

Examples:

# General help
paper-index-tool --help

# Command help
paper-index-tool command --help

# Version info
paper-index-tool --version

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
paper-index-tool command -v

# DEBUG level - see detailed info
paper-index-tool command -vv

# TRACE level - see all internals
paper-index-tool command -vvv

Shell Completion

Native shell completion for bash, zsh, and fish.

Installation:

# Bash (add to ~/.bashrc)
eval "$(paper-index-tool completion bash)"

# Zsh (add to ~/.zshrc)
eval "$(paper-index-tool completion zsh)"

# Fish (save to completions)
paper-index-tool completion fish > ~/.config/fish/completions/paper-index-tool.fish

Pipeline Composition

Compose commands with Unix pipes for powerful workflows.

Examples:

# Example pipeline workflows will be added when CLI commands are implemented
paper-index-tool command --json | jq '.'

Common Issues

Issue: Command not found

# Verify installation
paper-index-tool --version

# Reinstall if needed
cd paper-index-tool
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
paper-index-tool --help

# Command-specific help
paper-index-tool 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

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

Resources

GitHub: https://github.com/dnvriend/paper-index-tool
Python Package Index: https://pypi.org/project/paper-index-tool/
Documentation:

skill-paper-index-tool