docs: add comprehensive CLI command reference (closes #65)#127
Closed
DsThakurRawat wants to merge 1 commit into
Closed
docs: add comprehensive CLI command reference (closes #65)#127DsThakurRawat wants to merge 1 commit into
DsThakurRawat wants to merge 1 commit into
Conversation
Collaborator
|
Thanks @DsThakurRawat — the structure of this reference (orientation → per-verb sections → vertical matrix → env vars) is solid. I want to credit you for that. I've opened a consolidated, source-audited replacement. You're credited via Key differences from this PR:
Closing in favor of the replacement PR. Please keep contributing! |
5 tasks
rylinjames
added a commit
that referenced
this pull request
May 15, 2026
Adds docs/cli_reference.md — a single user-facing reference for every visible reflex command. Audited against src/reflex/cli.py so every verb, flag, and example matches the live source. Examples for each top-level verb are real (no fabricated flag combinations). Drops fabricated content from the original attempt (#127) — the deprecated 'reflex turbo' verb, the internal-only 'reflex bench', the never-existed 'AGV / GPS-fused state' guidance — and replaces it with content grounded in the FastCrest customer research vault: the Vertical Quick-Start Matrix now mirrors the P0 customer subcategories (warehouse AMR, autonomous tractors, mining, drone surveillance, last-mile drone delivery, traffic management, smart-camera retail/ warehouse, ADAS/autonomous trucking, port inspection, baggage tugs). Documents the new --state-msg-type flag from #133 alongside the recommended drone state topics (/mavros/local_position/odom for full state, /mavros/imu/data for orientation-only fallback). Supersedes #127. Co-authored-by: Divyansh Rawat <186957976+DsThakurRawat@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Description
Creates a comprehensive
docs/cli_reference.mdto document everyreflexCLI command. This resolves the issue of users needing to run--helprepeatedly.Key Additions:
go,serve,ros2-serve,export,validate,doctor,guard,bench,models, andchat.Type of Change
How Has This Been Tested?
pytest tests/passes locallyreflex doctorsanity checkChecklist