steel-dev__cli/docs

Steel CLI Documentation

This folder contains auto-generated documentation for the Steel CLI.

Files

• cli-reference.md - Complete CLI reference documentation with all commands, options, and available templates

Regenerating Documentation

To regenerate the documentation after making changes to the CLI commands:

npm run docs:generate

This will:

1. Build the TypeScript project
2. Scan all CLI commands
3. Extract templates from the constants file
4. Generate updated markdown documentation

Auto-generation Details

The documentation is generated by the scripts/generate-docs.js script, which:

• Scans the source/commands/ directory for all available commands
• Extracts command descriptions, arguments, and options using Zod schema introspection
• Loads available templates from source/utils/constants.ts
• Generates formatted markdown documentation in the Fly.io CLI style

The generated documentation includes:

• Complete command reference
• Usage examples
• Available templates for run and forge commands
• Command arguments and options
• Table of contents with anchor links