flightopsDocumentation
Reference

Documentation index

4 min readdocs/DOCUMENTATION-INDEX.md (source repository)

Flightops is in beta (0.2.0b1) for invited ROS 2 teams. Read the beta first, then install and follow first steps. Use the user guide for everyday workflows with expected results and troubleshooting. Use the task guides below for a specific result.

The beta

PageUse it for
The betaWhat is included, known limits, feedback
Release notesWhat changed in 0.2.0b1
Privacy noticeWhat the beta service keeps and for how long
License and usage metricsActivation, renewal, devices and the metrics that are sent

Tutorials

TaskGuide
Open Flightops and learn the controlsFirst steps
Test on fresh Ubuntu with your own package and TurtleBot3Fresh Ubuntu demo
Attach to ROS nodes that are already runningAttach
Start and stop a ROS launch fileLaunch
Diagnose real Nav2, Panda, and Go2 simulation faultsROS 2 troubleshooting examples (offline HTML)
Set up optional AIAI setup
Open and keep a results reportResults
Read a recording without ROSRecording quickstart
Record a demo topic, query it, and reopen its reportCapture to report
Read the terminal and report screensScreen tour
Replay a recording or compare two runs in the desktop appScene Workbench
Run a test sessionTesting checklist

AI assistance

Task guides

TaskGuide
Check topic delivery or lifecycle state after launchLaunch readiness
Trace a map, lidar, planner, joint, or control-topic faultROS 2 troubleshooting examples
Investigate a ROS project from source to live observationsDevelopment workspace (source repository)
Compare parameters and inspect message-time transformsDevelopment tools (source repository)
Plan and retain a development experimentDevelopment experiments (source repository)
Save and reopen project settingsProject profiles
Resolve a selected launch file and its declarationsLaunch resolution
Set up the launch gate for a projectProject intake
Inspect parameter provenance, timelines, or change impactInvestigation workflows
Inspect laser, IMU, or depth inputsDevice recipes
Run repeated seeded simulation experimentsSimulation experiments
Test a depth-camera pipelineDepth camera
Run an agent development experimentDeveloper test lab (source repository)
Compare simulation runs or inject a bounded faultBehavior and fault workflows
Prepare a recording for replayReplay readiness
Compare two saved proof recordsProof comparison
Package evidence for another machineReproduction packages
Deliver to a remote development containerRemote development (source repository)
Run local Docker and KVM acceptance checksLocal VM testing (source repository)

Reference

ReferenceUse it for
Command linePublic commands and common options
Build featuresWhat the beta build includes
License and usage metricsActivation, renewal, devices and metrics
GlossaryPlain-language definitions and term links
Terminal workspace (source repository)Views and keyboard controls
Integrations (source repository)MCP setup, results reports, and source builds
Scene Workbench protocol (source repository)The local service protocol behind the Scene Workbench
Bounded evidence queriesMCAP query clocks, limits, and result meaning
TF historySession TF collection, clocks, and bounds
TroubleshootingCommon setup and launch problems
Supported ROS and Gazebo environments (source repository)Supported development images
Scenario format (source repository)Versioned scenario fields and semantics
Security boundaries (source repository)Execution, evidence, and hardware limits

Reference pages by topic

Each page describes one command family or data format. The command reference maps every flightops command to its page.

TopicPageUse it for
RecordingManaged recordingHow a launch arms bounded capture, and its limits
RecordingManaged recording commandsflightops record enable, list, show, and view
RecordingIndependent collectorA separate exact-topic recorder that does not control the application
RecordingRetentionScoped budgets, pins, read leases, and expiry plans
RecordingRecording reductionShrinking one recorded failure to a bounded replay
RecordingEvidence resolverDigest-bound receipts and bounded recording segments
HistoryHistory commandsflightops history and flightops checks
HistoryHistory catalogThe local SQLite index and its record shapes
HistoryKnowledgeCases and immutable strategy revisions
HistoryOwned sourcesImported owned text files as inert sources
HistoryGoverned learningEvaluation suites and conditional training decisions
HistoryRetrospective AIReviewed disclosure and one optional provider turn
ChecksCheck catalogThe three bounded sensor observations
ChecksCheck rankingDeterministic ordering and run-check
ChecksChange reviewComparing snapshots to select affected checks
ChecksIntegration contractsFrozen requirements evaluated against saved observations
Workspace and sharingPersonal workspaceThe private loopback desktop workspace
Workspace and sharingStructured handoffMoving a task timeline between users in quarantine

Component tools

ToolGuide
Live graph and topic inspectiononscope (source repository)
Recording analysis and replay fixturessplashdown (source repository)
Build, test, and simulation gateslaunchcommit (source repository)
Reusable build workspaceshighbay (source repository)
ROS skills for coding agentsflightschool (source repository)
Coordinator directory for coding agents (preview)flightlead (source repository)
MCP server and results reportsintegrations (source repository)
Desktop app for recordingsScene Workbench and its build notes (source repository)
Local KVM smoke task (research preview)Gym (source repository)
Shared data and evidence libraryaxikit (source repository)
Recording-to-regression workflowRecorded failures (source repository)

Project and contributor guides

  • Contributing (source repository) explains how to work in this repository.
  • Demo project (source repository) explains the bundled ROS example.
  • Safety model (source repository) holds the safety requirements that outrank every other design choice.
  • Known limits lists what the beta does not do and what has not been checked.

For a short overview of the component workflows, use the advanced guide.