agentleFS
Sign inStart free
elodin-syselodin-sys/elodin/AGENTS.md

elodin

AGENTS.md553 starsChanged 5 months agoApache-2.0View on GitHub

Elodin is an open-source platform for rapid design, testing, and simulation of aerospace and physical systems — aerospace's answer to ROS. This monorepo contains the Elodin Editor (3D viewer/graphing), Elodin DB (time-series telemetry database), the Python SDK (nox-py, JAX-based simulation), flight software components, and the Aleph flight computer NixOS configuration (NVIDIA Jetson Orin). For in-depth instructions, read the relevant skill file below when working in that area:

The file

We split this AGENTS.md into the rules it gives an agent

8 rules. About 0 are common, 5 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Always use the nix develop shell when developing changes.

    line 7
  2. Very specific:

    Always use uv inside the nix shell for Python everything (just install sets this up).

    line 8
  3. Distinctive:

    Don't commit changes to git — that's for the developer to do

    line 10
  4. Distinctive:

    When suggesting new dependencies, check they are well supported and maintained.

    line 11
  5. Distinctive:

    Avoid Cargo features. Prefer one supported configuration.

    line 12
  6. Distinctive:

    Never use unsafe Rust code.

    line 13
  7. Distinctive:

    Run all activities from the repository root.

    line 14
  8. Very specific:

    When running cargo test -p elodin-db, prevent crashing with flags: "CARGO_BUILD_JOBS=1 RUST_TEST_THREADS=1 RAYON_NUM_THREADS=1"

    line 15

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Elodin

Elodin is an open-source platform for rapid design, testing, and simulation of aerospace and physical systems — aerospace's answer to ROS. This monorepo contains the Elodin Editor (3D viewer/graphing), Elodin DB (time-series telemetry database), the Python SDK (nox-py, JAX-based simulation), flight software components, and the Aleph flight computer NixOS configuration (NVIDIA Jetson Orin).

Rules

  • Always use the nix develop shell when developing changes.
  • Always use uv inside the nix shell for Python everything (just install sets this up).
  • Agents build with just install.
  • Don't commit changes to git — that's for the developer to do
  • When suggesting new dependencies, check they are well supported and maintained.
  • Avoid Cargo features. Prefer one supported configuration; add a feature only for a demonstrated platform or dependency boundary, never for speculative optionality or fallback modes.
  • Never use unsafe Rust code.
  • Run all activities from the repository root.
  • When running cargo test -p elodin-db, prevent crashing with flags: "CARGO_BUILD_JOBS=1 RUST_TEST_THREADS=1 RAYON_NUM_THREADS=1"

Quick Start

Python SDK (always build first, so binaries pick it up)

nix develop
just install

CI Checks

cargo fmt && cargo test && cargo clippy -- -Dwarnings   # Rust
ruff format --check && ruff check --fix                  # Python
alejandra                                                # Nix

Detailed Guidance

For in-depth instructions, read the relevant skill file below when working in that area:

  • Creating simulations (Python SDK, components, systems, 6DOF, visualization, SITL/HITL): .cursor/skills/elodin-simulation/SKILL.md
  • Monte Carlo + truth data (calibrating sims against experimental data, campaign specs/hooks, truth-replay ghosts, run scoring, reconstruction): .cursor/skills/elodin-monte-carlo/SKILL.md
  • Contributing to the codebase (building from source, architecture, workspace structure, testing): .cursor/skills/elodin-dev/SKILL.md
  • Rust style (error types, API design don'ts): .cursor/skills/rust/SKILL.md
  • Aleph flight computer (AlephOS deployment, NixOS modules, flight software services, firmware): .cursor/skills/elodin-aleph/SKILL.md
  • Elodin DB (running the database, client integrations, replication/follow mode, Lua REPL): .cursor/skills/elodin-db/SKILL.md
  • Elodin Editor (Bevy/Egui architecture, hot-reload, viewport, telemetry graphs, KDL schematics): .cursor/skills/elodin-editor-dev/SKILL.md
  • Headless editor capture (Gamescope, screenshots, PipeWire, video capture): .cursor/skills/elodin-headless-capture/SKILL.md
  • Python SDK internals (PyO3 bindings, nox-py, JAX integration, adding components/systems): .cursor/skills/nox-py-dev/SKILL.md
  • Nix environment (dev shell troubleshooting, OrbStack VMs, flake.nix, binary cache): .cursor/skills/elodin-nix/SKILL.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free