agentleFS
NVIDIAKnown publisherNVIDIA/IsaacCapture/src/core/deviceio_base/AGENTS.md

IsaacCapture / deviceio_base

AGENTS.md438 starsChanged 31 days agoApache-2.0View on GitHub

CRITICAL (non-optional): Before editing this package, complete the mandatory AGENTS.md preflight in ../../../AGENTS.md (read every applicable AGENTS.md on your paths, not just this file). Only hand-written trackers keep their <name>_tracker_base.hpp in cpp/inc/deviceio_base/. The impl interface for a tracker declared in ../deviceio_trackers/trackers.toml is generated into ${CMAKE_BINARY_DIR}/generated/trackers/deviceio_base/ and reaches consumers through the same <deviceio_base/...> include path, so a missing header there usually means a stale build tree rather than a missing file. Do not hand-add a base header for a manifest tracker.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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:

    CRITICAL (non-optional): Before editing this package, complete the mandatory AGENTS.md preflight in ../../../AGENTS.md (read every …

    line 8
  2. Very specific:

    Do not: use XrTime, <openxr/openxr.h>, or OpenXR link targets in this library.

    line 13
  3. Very specific:

    Only hand-written trackers keep their <name>_tracker_base.hpp in cpp/inc/deviceio_base/.

    line 20

≈ “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
<!-- SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 -->

Agent notes — deviceio_base

CRITICAL (non-optional): Before editing this package, complete the mandatory AGENTS.md preflight in ../../../AGENTS.md (read every applicable AGENTS.md on your paths, not just this file).

API

  • ITrackerImpl::update takes int64_t monotonic_time_ns (system monotonic clock, same domain as core::os_monotonic_now_ns()).
  • Do not use XrTime, <openxr/openxr.h>, or OpenXR link targets in this library. Keep the tracker abstraction runtime-agnostic.
  • Query accessors return Serialized<XPayload>, never a generated -T and never a wrapper table. The object-API types are an implementation detail of whoever assembles the payload; they must not appear in any ITrackerImpl or ITracker signature. See <schema/serialized.hpp>.
  • Keep Serialized<T> schema-agnostic. It owns a buffer and re-points within it; it knows nothing about any field, so reaching one is the caller's job: record.narrow(record->data()). Narrow from the same handle you read the field through — narrow() pairs whatever pointer it is given with this handle's owner, so narrowing one wrapper onto another's field compiles and yields a handle owning the wrong buffer.
  • An empty handle is the absent payload — device inactive, no sample yet, replay gap. Consumers test one condition (if (handle)). Do not reintroduce a wrapper table to carry optionality: that was what the Tracked tables did before the handle became nullable, and it made every read a two-step null check. The exception is the message channel, whose payload is a list: a batch needs a table to hold the vector, and "nothing this frame" is an empty batch rather than an absent one.

Generated I<Name>TrackerImpl headers

Only hand-written trackers keep their <name>_tracker_base.hpp in cpp/inc/deviceio_base/. The impl interface for a tracker declared in ../deviceio_trackers/trackers.toml is generated into ${CMAKE_BINARY_DIR}/generated/trackers/deviceio_base/ and reaches consumers through the same <deviceio_base/...> include path, so a missing header there usually means a stale build tree rather than a missing file. Do not hand-add a base header for a manifest tracker.

CMake

  • deviceio_base is an INTERFACE library: list only what the headers actually need (e.g. isaacteleop_schema). Do not link OpenXR::headers or oxr::oxr_utils here.
  • The generated-header directory is added by the packages that consume it (deviceio_trackers, live_trackers, replay_trackers), not by this INTERFACE target.

Fallout for dependents

  • Targets that need OpenXR/oxr for compilation must declare those dependencies themselves (they are not implied by deviceio_base). See e.g. ../live_trackers/AGENTS.md. deviceio_trackers intentionally stays OpenXR-free—see ../deviceio_trackers/AGENTS.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.