rerun-io/rerun

rerun-docs

Where the Rerun documentation and code snippets live on disk and how to search them.

View source

How to use

  1. Copy the installation command and review the source package before installing it in your own agent environment.
  2. Check the source document for required tools, credentials and supported hosts.
  3. Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/rerun-io/rerun --skill rerun-docs

Before you start

  • Installation does not include a model subscription, API allowance or permission to access your files.
  • Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

Rerun docs

The source of <https://rerun.io/docs> and every code snippet it shows are plain files. Read them instead of guessing.

Where

  • In a Rerun checkout: docs/.
  • Inside the Rerun Viewer's agent panel: unpacked next to the skills, at ../../../docs relative to this file. The session preamble names the absolute path.

Layout

PathWhat
docs/content/**/*.mdThe website pages. docs/content/concepts/<name>.md maps to rerun.io/docs/concepts/<name>.
docs/content/reference/types/One page per archetype, component, view, and blueprint type.
docs/content/reference/viewer/, reference/sdk/, reference/cli.mdViewer, SDK, and CLI reference, including the viewer-mcp server.
docs/content/howto/, docs/content/getting-started/Task-oriented guides and tutorials.
docs/content/changelog/Release notes, oldest to newest.
docs/snippets/INDEX.mdTable of every snippet: feature, name, one-line description, and which languages exist. Start here.
docs/snippets/all/<category>/<name>.{py,rs,cpp}The snippets themselves. archetypes/, views/, howto/, concepts/, tutorials/, quick_start/. Same name in each language means the same example.

Each markdown page starts with front matter (title, order); the body is the page. Recording files (*.rrd) next to the snippets are not shipped with the viewer.

How

  1. Search first, then read: rg -l "<term>" docs/content docs/snippets/all.
  2. For "how do I log X": open docs/snippets/all/archetypes/<x>.py (or .rs, .cpp) and docs/content/reference/types/archetypes/<x>.md.
  3. For "how does X work": docs/content/concepts/.
  4. When pointing the user at a page, give the website URL derived from the file path, not the local path.
  5. The Python API reference and docs.rs/rerun are not on disk; use WebFetch for those.
from this repository

More skills

All skills