docs: enrich auto-generated CLI reference with examples and description#2773
Merged
tempusfrangit merged 1 commit intomainfrom Feb 24, 2026
Merged
docs: enrich auto-generated CLI reference with examples and description#2773tempusfrangit merged 1 commit intomainfrom
tempusfrangit merged 1 commit intomainfrom
Conversation
… docs Add Long descriptions and Example fields to build, run, push, init, predict, and serve commands so the auto-generated docs/cli.md includes actionable usage examples and context. Regenerate docs/cli.md and docs/llms.txt.
tempusfrangit
changed the title
markphelps
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The auto-generated
docs/cli.mdwas bare-bones — just flags, no context or examples. This addsLongdescriptions andExamplefields to the cobra command definitions for all major commands so the generated output is actually useful.Commands updated
cog build— Long description + examples (tag, no-cache, separate-weights)cog run— Long description + examples (python, scripts, env vars, ports)cog push— Long description + examples (Replicate, generic registry, separate-weights)cog init— Long description + examplecog predict— Examples (named inputs, file inputs, output path, JSON, pre-built image)cog serve— Long description + examples (default port, custom port, curl test)Regenerates
docs/cli.mdanddocs/llms.txt.