flightopsDocumentation

This is the documentation shipped with your Flightops release. Links to websites need internet; links marked (source repository) are not part of it.

Flightops documentation

Flightops documentation

3 min readdocs/README.md (source repository)

Flightops helps you inspect ROS 2 systems, recordings and saved evidence. Flightops is in beta (0.2.0b1) for invited ROS 2 teams. Start with installation and first steps, then choose a task. Use a laptop or desktop terminal at least 120 columns by 36 rows.

Start here

  1. The beta: what is included, known limits, and where to send feedback.
  2. Install Flightops for your Ubuntu version, then activate this device.
  3. First steps: observe a demo node in two terminals.
  4. User guide: follow everyday tasks and recover from common errors.

Release notes · Beta terms (source repository) · Privacy notice · Feedback: beta@flightops.dev

Other starting points

Tutorials

Work through a tutorial to complete one task.

Use the user guide for a complete everyday workflow.

Scene Workbench

AI assistance

How-to guides

TaskGuide
Check topic delivery or lifecycle state after launchLaunch readiness
Read and search a launch log in the terminalLaunch log summary and recall
Connect a project to live observations and local checksDevelopment workspace (source repository)
Investigate a failureInvestigation workflows
Follow screenshot-supported ROS 2 fault examplesROS 2 troubleshooting examples
Query a recordingEvidence queries
Prepare a recording for replayReplay readiness
Gate a change in a projectProject intake and launchcommit (source repository)
Compare retained runsProof comparison
Reproduce a run elsewhereReproduction packages
Run the bundled simulation (source checkout)Simulation demo (source repository)

Advanced guides use the component commands where needed. The advanced user guide covers the component workflows.

Component tools

ToolGuide
onscope: ROS 2 graph and runtime diagnosisonscope (source repository)
splashdown: recording analysissplashdown (source repository)
lcc: the launch gatelaunchcommit (source repository)
highbay: warm build containershighbay (source repository)
flightops-mcp: MCP server for coding agentsintegrations (source repository)
flightschool: ROS 2 skills for coding agentsflightschool (source repository)
flightlead (preview): coordinator for coding agentsflightlead (source repository)
flightops-gym-smoke (research preview)Gym (source repository)

Reference

  • Command reference: every flightops command, the other installed commands and their reference pages.
  • License and usage metrics: activation, renewal, devices and what is sent.
  • Reference pages by topic: recording, history, checks and workspace.
  • Build features: what the beta build includes.
  • Glossary: short definitions of the terms used here.
  • Terminal controls (source repository).
  • Troubleshooting.
  • Supported ROS and Gazebo environments (source repository).
  • Scenario format (source repository).
  • Security and execution boundaries (source repository).

Development

  • Contribute (source repository) and run development experiments (source repository).
  • Local Docker and KVM testing (source repository): create and verify disposable Ubuntu guests.
  • All documentation: component guides and technical references.

Read offline or edit the docs

Open the HTML edition locally; an installed build has its own copy (flightops docs --open). Tutorials and maintained guides have navigation and copyable commands. Markdown files are the source of truth. Use Search offline guides to find a command, term, or error across the offline guides. Every search word must match a section; results link to that section. Search runs locally, including when pages open from file://. In the copy shipped with an install, links to files outside the user guide show as "(source repository)".

From the repository root, regenerate the HTML after an edit:

bash
python3 scripts/render-user-guide.py --all
python3 scripts/render-user-guide.py --all --check

For documentation authors, see the writing standard (source repository).