forge-readme

# forge-readme

Create a README.md for a CmdForge tool from its config.yaml

## Installation

This is a CmdForge tool. Install it via:

```bash
cmdforge install forge-readme
```

Or if available in a collection:

```bash
cmdforge collection install <collection-name>
```

## Usage

This tool reads a CmdForge tool's `config.yaml` and generates a comprehensive README.md file.

```bash
# Generate README from a tool's config
cat ~/.cmdforge/my-tool/config.yaml | forge-readme

# Or using command substitution
forge-readme < ~/.cmdforge/my-tool/config.yaml

# Save to file
cat ~/.cmdforge/my-tool/config.yaml | forge-readme > README.md
```

## Arguments

This tool does not accept any custom arguments.

## How It Works

The tool operates in a 2-step pipeline:

1. **parse_config** (code step): Parses the YAML configuration file to extract tool metadata including name, description, arguments, steps, dependencies, and version information.

2. **write_readme** (prompt step): Uses the Claude Sonnet AI provider to generate a well-structured README.md based on the parsed metadata. The AI formats the documentation with proper sections including tool name, description, installation instructions, usage examples, arguments table, step-by-step explanation, and dependencies.

## Dependencies

None

---

*Generated with CmdForge v1.0.0*