docs: comprehensive CLI command reference (closes #65)#134
Merged
Conversation
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 was referenced May 15, 2026
rylinjames
added a commit
to DsThakurRawat/reflex-vla
that referenced
this pull request
May 19, 2026
The existing 10 m/s ceiling capped end-effector velocity, which made sense for arms but blocked legitimate aerial flight speeds. Quadcopter and delivery drones routinely operate at 15-50 m/s (54-180 km/h). Raises max from 10.0 -> 50.0 and polishes the description to make the dual-use semantics explicit. None of the four shipped presets are affected (franka 1.0, ur5 1.0, so100 0.5, quadcopter 5.0 — all well under both ceilings). Originally proposed by @DsThakurRawat in FastCrest#119; this commit applies just the actual schema delta on top of current main, since the PR branch predated FastCrest#132 (quadcopter preset) and FastCrest#134-FastCrest#138 — naively merging would have reverted that work. Co-Authored-By: DsThakurRawat <divyanshrawatofficial@gmail.com> Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
rylinjames
added a commit
that referenced
this pull request
May 19, 2026
…nts (#119) The existing 10 m/s ceiling capped end-effector velocity, which made sense for arms but blocked legitimate aerial flight speeds. Quadcopter and delivery drones routinely operate at 15-50 m/s (54-180 km/h). Raises max from 10.0 -> 50.0 and polishes the description to make the dual-use semantics explicit. None of the four shipped presets are affected (franka 1.0, ur5 1.0, so100 0.5, quadcopter 5.0 — all well under both ceilings). Originally proposed by @DsThakurRawat in #119; this commit applies just the actual schema delta on top of current main, since the PR branch predated #132 (quadcopter preset) and #134-#138 — naively merging would have reverted that work. Co-authored-by: RomirJ <playindus@gmail.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
1 participant
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
Adds
docs/cli_reference.md— a single user-facing reference for every visible reflex command. Closes #65.Adapted from #127
@DsThakurRawat opened #127 with the same goal. The doc structure (verb overview → per-verb sections → vertical matrix → env vars) is theirs and good; preserved via
Co-Authored-Byon the commit.What this PR fixes vs #127
reflex turboas a current verbreflex serve --adaptive-stepsreflex benchas user-facinghidden=True+ internal-only per v0.9.5 CHANGELOGreflex validate-datasetand other hidden verbs as top-levelhidden=Truein sourcereflex ros2-servetreated as a normal top-level verb--helpbut production-supported" caveat; also adds the new--state-msg-typeflag from #13302_research/customers/MASTER.mdin the FastCrest research vault: traffic-management, retail, warehouse-camera, drone surveillance are all P0 customer subcategories (12-13/15 composite scores). The matrix now mirrors the vault's top 11 P0 picks.reflex <verb> --helppointers for the full list (prevents future drift)What I added beyond fixing
--state-msg-type {joint_state|imu|odom}introduced in fix(ros2): pluggable state extractors (joint_state / imu / odom) #133, with the right MAVROS topic recommendations for drones.ros2-serveandreplay(hidden from--helpbut production-supported) so power users can discover them.turbo,split,adapt— print banners pointing to replacements).What's deliberately omitted
Full flag list: reflex <verb> --helpso this doc can't drift from source.bench,bench-game,targets,guard,check,calibrate,status,config show/set,validate-legacy,validate-dataset.Closes / supersedes
good first issue)Test plan
@app.command()insrc/reflex/cli.pywithhidden=False(verified viagrep -n "@app\.command" src/reflex/cli.pycross-referenced against the livereflex --helpoutput)ros2-serve,replay) is@app.command(hidden=True)but otherwise production code paths--state-msg-typeflag matches fix(ros2): pluggable state extractors (joint_state / imu / odom) #133's implementation02_research/customers/MASTER.mdas P0 tiermkdocs serveor equivalent (no docs site build wired up in this repo — the file is GitHub-rendered Markdown)