Skip to content

Companion APIs ​

These Public and Full references render the real Julia docstrings of the optional packages from this site's documented source revision. Core remains at the registered package source; companions have their own versions. A newer renderer is identified separately in build-info.json and verified against its own published tag for a stable documentation refresh. Each owner is loaded in a separate documentation project. Full API includes documented internal bindings; it does not promise documentation for every private helper.

OwnerPublic APIFull APIReference inventory
PerfCheckerLinuxPerf 1.0.1PublicFullInventory
PerfCheckerLIKWID 1.0.1PublicFullInventory
PerfCheckerMakie 1.0.4PublicFullInventory
PerfCheckerWeb 1.0.0PublicFullInventory
PerfCheckerPluto 1.0.1PublicFullInventory
PerfCheckerTachikoma 1.0.1PublicFullInventory

The Core Public API and Core Full API document Core's bindings. A companion can define methods of a Core binding: for example, PerfCheckerWeb defines methods of PerfChecker.serve_suite. The Julia signatures, source links and per-owner provenance retain that distinction. Makie's real WGL extension documents PerfChecker.performance_plot_html; that Core binding is not an additional export of the extension. Web's own version remains 1.0.0, independent of the Core package version.

Each inventory is relative to this site's optional-api/ directory. Inventories remain separate because a shared Core binding can have different methods in different owners. They supplement Core's objects.inv without replacing entries. The corresponding <owner>.toml files in that directory record the source commit, Docs and method owners, signatures, source hashes and rendering inputs.

See installation for source installation and compatible worker environments. Generating references does not start a server, open Pluto, render a plot, run a terminal interface or measure a hardware counter. LinuxPerf and LIKWID require their documented permissions and native prerequisites; their explicit Julia executor is not a native CLI, VS Code, Pluto or MCP selector.

The stable Core 1.0.0 site retains its own APIs. These companion references are not injected into an explicit documentation-only refresh of that release.

Open source · Report an issue · Contributions welcome