Skip to main content
command CX Codex

cli — Claude Code command: capture CLI help in CLAUDE.md

This command checks whether a CLI tool is available, captures its help output, and adds it to CLAUDE.md for future reference.

MIT ★ 763 updated 2026-03-31

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/commands/cli.md
Open on GitHub

What cli does

The command checks for the requested executable, then tries --help, -h, and help in that order. It captures output from stderr as well as stdout, strips ANSI escape codes, and keeps examples and options intact.

The captured material goes into a collapsible entry under CLI Tools Reference in CLAUDE.md. New tools are placed alphabetically; if the section is missing, the command creates it after Configuration. Very long output is reduced to key sections. If the tool cannot be found, the command suggests checking its installation and PATH.

To install it in Claude Code, save the command file as .claude/commands/cli.md. When CLAUDE.md is a symlink, the command edits its target, likely AGENTS.md.

What it helps with

  • check whether a CLI tool is available on PATH
  • save help for npm, git, or cargo in CLAUDE.md
  • add a tool entry in alphabetical order
  • trim help output longer than 500 lines to key sections

Example prompts for the agent

  • Add the npm help text to CLAUDE.md: /agents-md:cli npm.
  • Check whether git is available and record its help: /agents-md:cli git.
  • Add the cargo command reference to the project: /agents-md:cli cargo.

How to install cli

Manually: put the files in place

.claude/commands/cli.md

Call it with /cli. For all projects use ~/.claude/commands/

Questions about cli

How do I install cli in Claude Code?

Save the command file as .claude/commands/cli.md.

What does cli do?

It checks for a CLI executable, captures its help text, and adds that reference to CLAUDE.md.

What happens when the help output is very long?

When it exceeds 500 lines, the command captures key sections only.

Source text

cli.md · MIT
---
description: Capture CLI tool help documentation and add it to CLAUDE.md for AI assistant reference
category: claude-setup
allowed-tools: Bash(*:--help), Bash(*:-h), Bash(*:help), Bash(which:*), Bash(echo:*), Bash(sed:*), Edit, Read
argument-hint: "<cli-tool-name>"
---

# Add CLI Tool Documentation to CLAUDE.md

Capture help documentation from CLI tools and add it to CLAUDE.md for future reference.

## Usage
`/agents-md:cli <tool-name>`

Examples:
- `/agents-md:cli npm`
- `/agents-md:cli git`
- `/agents-md:cli cargo`

## Task

### 1. Check Tool Availability
First, verify the CLI tool exists:
!`which $ARGUMENTS 2>/dev/null && echo "✅ $ARGUMENTS is available" || echo "❌ $ARGUMENTS not found"`

### 2. Capture Help Documentation
If the tool exists, capture its help output. Try different help flags in order:

```bash
# Try common help flags
$ARGUMENTS --help 2>&1 || $ARGUMENTS -h 2>&1 || $ARGUMENTS help 2>&1
```

### 3. Update CLAUDE.md
Add or update the CLI tool documentation in CLAUDE.md following these steps:

1. **Check for existing CLI Tools Reference section**
   - If it doesn't exist, create it after the Configuration section
   - If it exists, add the new tool in alphabetical order

2. **Format the documentation** as a collapsible section:
   ```markdown
   ## CLI Tools Reference
   
   Documentation for CLI tools used in this project.
   
   <details>
   <summary><strong>$ARGUMENTS</strong> - [Brief description from help output]</summary>
   
   ```
   [Help output here, with ANSI codes stripped]
   ```
   
   </details>
   ```

3. **Clean the output**:
   - Remove ANSI escape codes (color codes, cursor movements)
   - Preserve the structure and formatting
   - Keep command examples and options intact

4. **Extract key information**:
   - Tool version if shown in help output
   - Primary purpose/description
   - Most commonly used commands or options

### 4. Provide Summary
After updating CLAUDE.md, show:
- ✅ Tool documentation added to CLAUDE.md
- Location in file where it was added
- Brief summary of what was captured
- Suggest reviewing CLAUDE.md to ensure formatting is correct

## Error Handling
- If tool not found: Suggest checking if it's installed and in PATH
- If no help output: Try running the tool without arguments
- If help output is extremely long (>500 lines): Capture key sections only
- If CLAUDE.md is a symlink: Update the target file (likely AGENTS.md)

## Implementation Notes
When processing help output:
1. Strip ANSI codes: `sed 's/\x1b\[[0-9;]*m//g'`
2. Handle tools that output to stderr by using `2>&1`
3. Preserve important formatting like tables and lists
4. Keep code examples and command syntax intact

© carlrannaberg · MIT · carlrannaberg/claudekit

Similar slash commands

All slash commands for Agent setup: memory, context, orchestration →

From the same set54

The whole set →

Project sponsors

Companies that keep this analytics open