docs: add CLI reference and RunEvent field table#14
Merged
Conversation
Add docs/cli.md covering every flightdeck command, its flags, arguments, and exit codes — a stable public contract from v1.0.0: - Global flags and exit code table (0 success, 1 error, 2 checksum mismatch) - flightdeck init, doctor, serve with all options - release subgroup: register, list, show, verify, diff, promote, rollback, history - pricing subgroup: import (--replace/--reason semantics) and show - policy subgroup: set and show - runs subgroup: ingest (JSONL and JSON array formats) - End-to-end typical workflow section Extend docs/http-api.md with a RunEvent field reference table covering all top-level fields, metrics sub-fields, usage.model fields, and usage.tools[] entry fields with types, defaults, and descriptions. Update README.md Documentation section to link docs/cli.md and add the RunEvent reference note to the HTTP API entry. Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.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.
Docs added/updated
New:
docs/cli.md— CLI referenceAdds a complete CLI command reference covering every
flightdeckcommand as a stable public contract (v1.0.0+):flightdeck init,doctor,servewith all optionsreleasesubgroup:register,list,show,verify,diff,promote,rollback,historypricingsubgroup:import(including--replace/--reasonsemantics) andshowpolicysubgroup:setandshowrunssubgroup:ingest(JSONL and JSON array formats)Updated:
docs/http-api.md— RunEvent field referenceAdds a
RunEventfield reference table to thePOST /v1/eventssection covering:metricssub-object fields (success,latency_ms,error_type)usage.modelfields (all token count fields and provider/model)usage.tools[]entry fieldsUpdated:
README.mdLinks the new
docs/cli.mdin the Documentation section and notes the RunEvent field reference in the HTTP API entry.Which codepaths they cover
src/flightdeck/cli/main.py— all CLI commands, flags, exit codessrc/flightdeck/models.py—RunEvent,RunEventMetrics,RunEventModelUsage,RunEventToolUsagesrc/flightdeck/server/routes/ingest.py— event validation and api_version handlingsrc/flightdeck/storage.py—insert_run_eventsidempotency (duplicate run_id handling)Key knowledge gaps addressed
--helpfor each subcommand to discover flags and exit codes. Therelease verifyexit-2 contract and thepricing import --replaceaudit requirement were especially non-obvious.type,metrics.*,usage.tools[], or which fields are required vs optional. This is the primary input format for runtime evidence ingestion.