documentation hub

Use this hub only after the front door has told you what the product is and what to run first.

This is the documentation hub for agent-exporter. It is designed to reduce navigation overhead after first orientation: lock the product sentence, run the shortest truthful path, then come here for the matching shelf. If you still need the product story itself, go back to the flagship front door first.

Open GitHub front door Open archive proof Open repo map

Published shelf note: the latest release is the frozen public packet, while this docs surface may move ahead with repository-side truth on main.

First-success strip: scaffold + connectors -> HTML receipt -> archive shell.

this hub is best for

Main use
finding the right lane after you already know what the product is
Not for
first-time product orientation
Ground rule
quickstart path first, archive proof second, side lanes after that

docs hub in one screen

Pick the question before you pick the file.

front door

What is the product and what should I do first?

Open the GitHub front door when you still need the product sentence and first success path.

visual companion

Can I get a fast visual walkthrough before I run it?

Open the promo reel when a short visual pass will orient you faster than another wall of prose.

distribution-prep

What should I share after the product story is clear?

Open the launch kit for second-ring copy, asset routing, and reviewer-safe sharing notes.

structure

Where do the surfaces and files live?

Open the repo map when you already trust the product sentence and now need lane-by-lane routing.

product snapshot

Lock the product truth first, then branch.

Product kernel

Archive and governance workbench

agent-exporter is an archive and governance workbench that stays grounded in inspectable artifacts and proof rather than a hosted platform story.

Primary surface

Quickstart path

The operational door is still scaffold + connectors, one HTML receipt, then the archive shell.

Secondary surfaces

Archive, reports, integrations, governance

These lanes are real and landed, but they still do not replace the first screen.

Flagship packet

GitHub repo + CLI quickstart + archive shell proof

This remains the most honest public packet for the current stage.

The front door starts with the CLI quickstart. The archive shell proof is the first visible proof layer. Integration pack and governance lanes stay visible, but they do not own the first screen.

reading order by intent

Do not read the docs like a phone book.

  • If you want to decide whether the repo is worth trying once, open the GitHub front door and follow the first-success strip: scaffold + connectors -> HTML receipt -> archive shell.
  • If you want the first truthful visible proof, open archive shell proof.
  • If you want the structure of the workbench, open the repo map.
  • If you want registry or packet/listing truth, open the distribution packet ledger.
  • If you want host-native packet lanes, open the public skills packet.
  • If you want a local browser cockpit for Codex export or workspace-local Claude session export after the CLI path is already clear, run agent-exporter ui cockpit --workspace-root /absolute/path/to/repo.

first success orientation

Prove the desk stands up locally before opening side lanes.

01

Scaffold the workbench

cargo run -- scaffold
02

Read the connector surface

cargo run -- connectors
03

Export one transcript receipt

cargo run -- export codex --thread-id <thread-id> --format html --destination workspace-conversations --workspace-root /absolute/path/to/repo
04

Publish the archive shell

cargo run -- publish archive-index --workspace-root /absolute/path/to/repo

After that succeeds, you should see the scaffolded workbench shape, .agents/Conversations/*.html transcript receipts, .agents/Conversations/index.html, index.json, and share-safe packet tiers for teammate / reviewer / public forwarding rather than a hosted page.

public docs entry points

Each page answers a different class of question.

Companion docs home

Pages landing

https://xiaojiou176-open.github.io/agent-exporter/

Open Pages landing

Proof page

Archive shell proof

https://xiaojiou176-open.github.io/agent-exporter/archive-shell-proof.html

Open archive shell proof

Structure page

Repo map

https://xiaojiou176-open.github.io/agent-exporter/repo-map.html

Open repo map

Published shelf

Latest release

https://github.com/xiaojiou176-open/agent-exporter/releases/latest

Open latest release

secondary local stdio host packet

Keep this packet small, narrow, and honest.

why it stays second-ring

Packet truth is narrower than product identity.

Use the bridge packet when the question is about registry or read-back lanes. If the question is still "What is this repo?" or "How do I get one successful result?", stay on the README + archive shell proof path.

Release Shelf Truth

published packet

Use the latest release shelf for the newest published packet.

  • the tagged release notes
  • the frozen packet links for that tag
  • release notes for the shipped packet
  • the frozen packet state already inside a release

repository-side truth

Use the repo/docs surface for the newest truth on main.

  • front-door wording
  • packet and lane truth after the latest tag
  • docs or governance hardening that moved ahead of the current release

These shelves should stay conceptually aligned, but they are not the same shelf.

current surface snapshot

Read the product as a stack of proof lanes.

CLI core

Canonical export path

Codex app-server remains the canonical path, while local and claude-code stay landed companion paths.

archive shell proof

Transcript browser and backlinks

publish archive-index generates the transcript browser, workspace backlinks, family case views, latest-vs-pinned answer summaries, and the archive shell entrypoint.

reports shell

Saved retrieval receipts

search semantic|hybrid --save-report generates retrieval receipts and the reports shell.

integration pack

Repo-owned companion lane

integrate, doctor integrations, and onboard are the repo-owned integration companions.

MCP descriptor

Canonical registry/read-back descriptor

The root server.json remains the canonical local stdio bridge descriptor.

governance lane

Decision Desk and evidence

Evidence, baselines, policy packs, remediation, and official-answer lifecycle actions live in the local workbench via the archive shell Decision Desk and integration evidence reports.

secondary lane truth

Use packet/listing files only when lane truth matters.

Those files hold listed-live, review-pending, platform-not-accepted-yet, closed-not-accepted, build-contract-blocked, and exact_blocker_with_fresh_evidence states without turning packet status into the first screen.

maintainer-only references

These files matter, but not for a first-time public reader.

  • ../AGENTS.md
  • ../CLAUDE.md
  • ./adr/ADR-0001-source-layering.md
  • ./adr/ADR-0002-codex-first-delivery.md
  • ./reference/*