IsaacCapture / core
AGENTS.md438 starsChanged 31 days agoApache-2.0View on GitHub
CRITICAL: The mandatory multi-file AGENTS.md preflight in ../../AGENTS.md applies here too. Before changing anything under src/core/, you must have read this file, the repo root AGENTS.md, and every other AGENTS.md on the directory paths you will touch. Do not skip any of them. To see all AGENTS.md files in the Isaac Capture repo, use the find command (or **/AGENTS.md glob) documented in the repo root AGENTS.md—do not rely on a hand-maintained list in this file. If work under src/core/ went…
- Installs packages
1 other project uses a version of this.
Adopted by
Most recently taken up by
- NVIDIA/IsaacTeleopword for word, first seen Oct 13, 2026
Other versions1 project uses a version of this.
Word for word · 1
- NVIDIA/IsaacTeleop★ 438100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository28 other files it gives its agents.
- AGENTS.mdAGENTS.md
- deps/cloudxr/webxr_client/AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- examples/camera_streamer/AGENTS.mdAGENTS.md
- examples/egocap/AGENTS.mdAGENTS.md
- examples/teleop_ros2/AGENTS.mdAGENTS.md
- src/core/codegen/AGENTS.mdAGENTS.md
- src/core/deviceio_base/AGENTS.mdAGENTS.md
- src/core/deviceio_session/AGENTS.mdAGENTS.md
- src/core/deviceio_trackers/AGENTS.mdAGENTS.md
- src/core/live_trackers/AGENTS.mdAGENTS.md
- src/core/log_bridge/AGENTS.mdAGENTS.md
- src/core/replay_trackers/AGENTS.mdAGENTS.md
- src/core/schema/AGENTS.mdAGENTS.md
- src/plugins/sensing/AGENTS.mdAGENTS.md
- src/plugins/sharpa_avatar/AGENTS.mdAGENTS.md
- src/python/isaaccapture/cts/common/AGENTS.mdAGENTS.md
- src/python/isaaccapture/cts/full_body/checker/AGENTS.mdAGENTS.md
- src/python/isaaccapture/cts/full_body/oracle/AGENTS.mdAGENTS.md
- src/python/isaaccapture/cts/hand/AGENTS.mdAGENTS.md
- src/python/isaaccapture/cts/hand/checker/AGENTS.mdAGENTS.md
- src/python/isaaccapture/logging_config/AGENTS.mdAGENTS.md
- src/viz/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- .cursor/rules/cmake-structure.mdcCursor rule
- cmake-structureSkill
- rebot-orin-setupSkill
- rebot-orin-setupSkill
The file
We split this AGENTS.md into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 15
Prefer coarse-grained async boundaries around an existing synchronous step before splitting DeviceIO/source polling away from graph …
- Distinctive: line 17
Keep async retargeting comments short and local to invariants.
- Very specific: line 18
When changing TeleopSession retargeting execution defaults, update config, docs, and default-behavior tests together so opt-in vs.
- Very specific: line 20
After Python test or session-manager edits, let ruff format/pre-commit own wrapping and rerun the hook when it modifies files.
≈ “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.
Files
<!--
SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->Agent notes — Isaac Capture src/core (index)
CRITICAL: The mandatory multi-file AGENTS.md preflight in ../../AGENTS.md applies here too. Before changing anything under src/core/, you must have read this file, the repo root AGENTS.md, and every other AGENTS.md on the directory paths you will touch. Do not skip any of them.
To see all AGENTS.md files in the Isaac Capture repo, use the find command (or **/AGENTS.md glob) documented in the repo root AGENTS.md—do not rely on a hand-maintained list in this file.
If work under src/core/ went wrong—user correction, pre-commit/CI failure, or repeated same-class mistakes—you must follow the repo root AGENTS.md Mandatory learning loop: distill a short rule and update the nearest relevant AGENTS.md (this file or a package file) or source comments in the same session (including delta vs main scope).
- Async retargeting pacing behavior belongs on the pacing config objects; keep the worker focused on scheduling mechanics and avoid adding concrete pacing-mode or subclass branches there.
- Prefer coarse-grained async boundaries around an existing synchronous step before splitting DeviceIO/source polling away from graph execution; split internals only when a measured correctness or performance need justifies the extra thread-safety surface.
- In pipelined
TeleopSession,last_contextfollows the returned completed frame; reset/control-transition events travel with that frame and must not force exact-current-frame waits. Use sync mode for exact current-frame behavior. - Keep async retargeting comments short and local to invariants; user-facing pacing tuning guidance belongs in docs rather than long code docstrings.
- When changing
TeleopSessionretargeting execution defaults, update config, docs, and default-behavior tests together so opt-in vs. default semantics stay aligned. - Preserve existing
TeleopSessionlifecycle flag semantics unless changing the public/context-manager contract intentionally; use tests to lock down cleanup details before altering them. - After Python test or session-manager edits, let
ruff format/pre-commit own wrapping and rerun the hook when it modifies files. IDeviceIOSourceleaves are only discovered when reachable from a declared graph root — thepipelinecombiner's outputs, theteleop_control_pipeline, or a subgraph registered inTeleopSessionConfig(sinks=[...]).TeleopSession._discover_sourcesunions the leaves of all three. An input source whose only purpose is a side effect (e.g. message-channel send) must therefore expose at least one output (a heartbeat boolean is the established pattern) and be reachable from one of those roots; silent no-discovery is the recurring footgun. OutputIDeviceIOSinknodes are different: they are registered viaTeleopSessionConfig(sinks=[...])and the session runs and flushes them explicitly each frame, so a sink needs no heartbeat output and noOutputCombinerreachability.- A plugin a wheel install must be able to start is bundled into
isaaccapture/plugins/<name>/(binary +plugin.yaml, via a POST_BUILD copy andadd_dependencies(python_package ...)), and its binary must not need shared libraries the wheel does not ship. Apps start it explicitly withPluginConfig(search_paths=[BUNDLED_PLUGINS_DIR]); sources never start plugins. Seesrc/plugins/spacemouse. - All C++ diagnostics go through
isaaccapture::Logger(log_bridge/cpp/inc/log_bridge/logger.hpp), neverstd::cout/std::cerr/printf, and the logger name is alwaysisaaccapture.<module>.<ClassName>. The env-var contract and wire format are shared with the Python half, so a change to either must land in both — seelog_bridge/AGENTS.mdbefore touching the logging machinery, and the repo rootAGENTS.md"Logging" section for the rules that apply to every call site. - Run
clang-formaton touched C++ before pushing — CI rejects unformatted C++ and pre-commit does not catch it. See the formatting instructions in the repo rootAGENTS.md("Pre-commit — match CI before you stop") for the exact commands; the source of truth lives there, not here. - Authored
.pyundersrc/python/isaaccapture/carries no build-system registration. TheCONFIGURE_DEPENDSglob insrc/python/CMakeLists.txtstages every.pythere and[tool.setuptools.packages.find]discovers the packages, so a subpackage is a directory with an__init__.pyand nothing else — no packages list, noDEPENDSentry. Targets that produce files in the staging tree (pybind.so/.pyd,isaacteleop_pythoncopies,stage_generated_tracker_exports,viz_py, vendored runtimes, …) must be dependencies ofpython_package(DEPENDS/add_dependencies(python_package …)insrc/core/python/CMakeLists.txt), not the other way around — otherwise Windows ninja races the wheel build and setuptools fails witherror: package directory 'isaaccapture\\<name>' does not exist.python_packagewaits forviz_pywhenBUILD_VIZ=ON(.pydlink race). Central stubgen insrc/core/python/CMakeLists.txt(not aviz_pyPOST_BUILD) DEPENDS onpython_package, sostage_generated_tracker_exportsmust stay onpython_package's DEPENDS — otherwise stubbingisaaccapture.viz._viz(or any module that loadsisaaccapture/__init__.py) fails on the missing export. Forpip install -e .(scikit-build-core),_generated_tracker_exports.pymust also beinstall(FILES ...)underisaacteleop_wheel— the directory install excludes*.pyso authored sources stay redirect-resolved, but that module is not undersrc/python/. - The staging tree (
build/python_package/$<CONFIG>) is a copy destination, never the only place a file exists. A build step that writes straight into it leaves a wheel member with no build-tree origin, and the SBOM collector cannot explain it — it deliberately does not index staging, because indexing it would let the wheel explain itself. Generate intobuild/generated/<thing>/and copy in, the waystage_generated_tracker_exportsand the stub target both do. - Editing a
.fbsunderschema/fbs/can make every recording already on disk unreadable. Recorded MCAP embeds the schema it was written under;schema_testscompares the current schemas againstschema/golden/andMcapTrackerViewersre-checks at replay time. Readschema/AGENTS.mdandschema/README.mdbefore changing one. - Schema-based tracker sources exist only in a configured build tree. They are generated at CMake configure time from
deviceio_trackers/trackers.tomlinto${CMAKE_BINARY_DIR}/generated/trackers/, so greppingsrc/for a tracker such asSe3Trackerfinds the manifest entry and the generator, not a.cpp. Searching, debugging, and clangd all needcmake -B buildto have run first (already true for theflatcoutput). Seedeviceio_trackers/AGENTS.mdandcodegen/AGENTS.mdbefore adding or editing a tracker. OpenXRSessionwaits for the headset by default (wait_for_system = true).xrGetSystemanswersXR_ERROR_FORM_FACTOR_UNAVAILABLE(-35) until a system exists, and the retry loop is unbounded, holds the GIL for the whole wait (the pybind constructor releases nothing), and defersCtrl-Cuntil a headset turns up. Anything that constructs a session where no client will ever connect — CI, a headless smoke test — must impose its own timeout;deps/cloudxr/docker-compose.test.yamlwraps the CloudXR GPU tests in one for that reason.- CloudXR join-main (Orin): after the native service is up, do not start additional Python threads (including a
sigwaithelper). That re-triggers_PyGILState_NoteThreadState: Couldn't create autoTSSkey mapping. Keepnv_cxr_service_joinon the main thread only; rely on the launcher process teardown for shutdown while join blocks.
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
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.

