qgroundcontrol AGENTS.md

Repository instructions for QGroundControl, a flight-control application, covering C++ and QML style, architecture, testing, tools, and checks that run before code is accepted.

In plain words
What is it for?
Use them before changing QGroundControl code, especially when working with C++, QML, vehicle features, tests, or automated quality checks.
Why use it?
They require important reference files to be read before editing and identify rules whose violations can make continuous integration checks fail.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/mavlink/qgroundcontrol/agents-md
Clone the repo
git clone --depth 1 https://github.com/mavlink/qgroundcontrol

Made for: Codex, OpenCode.

Per session 1,521 This file is loaded in full into every session.
When invoked 1,521 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01521 $0.01521
Opus 5 $0.00760 $0.00760
Sonnet 5 $0.00304 $0.00304
Haiku 4.5 $0.00152 $0.00152

Measured 2d ago against content hash 5626f7ebbfa9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

qgroundcontrol AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 110 lines

How it starts

The opening of the file, as written. The whole thing — 110 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Instructions for AI coding agents (Codex, Claude Code, etc.) working on QGroundControl.

Quick References

  • CODING_STYLE.md — Naming, formatting, C++20 features, QML style, logging
  • .github/CONTRIBUTING.md — Architecture patterns (Fact System, Multi-Vehicle, FirmwarePlugin)
  • tools/README.md — Development scripts and tooling
  • test/README.md — Test framework, base classes, CTest labels, MultiSignalSpy, coverage
  • .github/ci-overview.md — CI workflow/action/script layout and conventions
  • .pre-commit-config.yaml — All enforced linters (clang-format, clang-tidy, ruff, pyright, shellcheck, actionlint, zizmor, qmllint, clazy, vehicle-null-check, check-no-qassert, check-no-qtest-ignore-message)

Required Preflight

Before modifying any repository file:

  1. Read CODING_STYLE.md completely.
  2. Read the task-specific references listed in this file.
  3. Do not begin editing until those reads are complete.
  4. Before the first edit, state in a progress update which instruction files were read.

Golden Rules (enforced — violations fail CI)

These are the non-negotiables. The first four are QGC's core architecture patterns; the rest are enforced by pre-commit hooks, so ignoring them wastes a build cycle. Full list with code examples: .github/CONTRIBUTING.md#architecture-patterns and CODING_STYLE.md#common-pitfalls.

  • Fact System — ALL vehicle parameters flow through Facts; never create custom parameter storage.
  • Multi-Vehicle — ALWAYS null-check activeVehicle() / Vehicle* before dereferencing (vehicle-null-check).
  • Firmware Plugin — use vehicle->firmwarePlugin() for firmware-specific behavior, not if (px4) branches.
  • QML Integration — register types with QML_ELEMENT/QML_SINGLETON/QML_UNCREATABLE; expose state via Q_PROPERTY.
  • No Q_ASSERT in production code — use defensive checks with early returns (check-no-qassert).
  • No QTest::ignoreMessage in tests — use expectLogMessage/ignoreLogMessage (check-no-qtest-ignore-message).
  • No fixed-delay QTest::qWait(<n>) — use QTRY_*_WITH_TIMEOUT or QSignalSpy::wait (check-no-fixed-qwait).
  • Comments — prefer self-documenting code; comment only non-obvious intent, constraints, or workarounds.

Read the full file on GitHub · 110 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 110 lines · 1,521 tokens per session scan A 5626f7ebbfa9

Subscribe to this mod's changes

qgroundcontrol AGENTS.md is an instructions file published in the GitHub repository mavlink/qgroundcontrol (4,888 stars, last pushed today), licensed Apache-2.0. It adds 1,521 tokens to every session, about $0.0076 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.