rerun-io/rerun

rerun-docs

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

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/rerun-io/rerun --skill rerun-docs

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

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.
来自同一仓库

更多 Skills

全部 Skills