CLI ReferenceCLI Overview
CLI Overview
The readme CLI is the single entry point for every generation command.
Invocation
uv run readme [COMMAND] [OPTIONS]uv run python -m scripts.cli [COMMAND] [OPTIONS]Command groups
generate
Generate any asset type — banner, QR, word cloud, art, skills, or README sections
config
View, save, or generate a default config.yaml
dev
Development tools — install, format, lint, test, clean, docs
show-settings
Print current app settings from environment
Global flags
| Flag | Effect |
|---|---|
--help | Show help message and exit |
--version | Show the version |
Generate subcommands
| Subcommand | Description |
|---|---|
banner | SVG banner (light + dark variants) |
qr | QR code PNG with embedded background |
word-cloud | OKLCH word cloud SVG |
generative | Lorenz / neural / flow-field generative art SVGs |
animated | CSS-animated SVGs seeded from commit history |
skills | shields.io skills badges section |
readme-sections | Assemble and update README dynamic sections |
all | Run all generators in sequence |
Dev subcommands
| Subcommand | Description |
|---|---|
install | Sync all dependencies |
format | Auto-format with ruff check --fix and ruff format |
lint | Lint with ruff, pylint, mypy |
test | Run pytest suite |
clean | Remove caches and artifacts |
docs | Serve Fumadocs dev site locally |
update-deps | Update lockfile to latest versions |