Crate toolpath_copilot 

toolpath-copilot

Derive Toolpath provenance documents from GitHub Copilot CLI session logs — the standalone agentic CLI distributed as the npm package @github/copilot (command copilot).

⚠️ Preview — schema partly verified. Copilot CLI’s events.jsonl format is undocumented. This crate was first built from docs + community reverse-engineering, then verified against a first-hand session capture at copilotVersion 1.0.67: the line envelope, session.start context, tool.execution_* (incl. result.content), assistant.message (reasoningText/outputTokens), and system.message are confirmed. Event types that didn’t occur in that session (subagent.*, skill.invoked, hook.*, abort, session.shutdown, compaction) and the checkpoints/ format remain unverified — the parser stays deliberately tolerant (payload inline or nested, multiple key spellings, unknown events preserved). See the format reference + verification checklist at docs/agents/formats/copilot-cli/.

What it reads

Sessions live under ~/.copilot/session-state/<session-id>/ (override the root with COPILOT_HOME):

• events.jsonl — the append-only event stream this crate parses into a conversation.
• workspace.yaml — git context (root / repository / branch / revision), read into Path.base (tolerant key-scan parser; the schema is reverse-engineered).
• checkpoints/ — file snapshots (not yet consumed; see file-fidelity.md).

It also tolerates the legacy history-session-state/ location.

Usage

use toolpath_copilot::{CopilotConvo, derive};

let convo = CopilotConvo::new();

// List sessions (newest first).
for meta in convo.list_sessions()? {
    println!("{}  {}", meta.id, meta.first_user_message.unwrap_or_default());
}

// Read one and derive a Toolpath `Path`.
let session = convo.read_session("<session-id-or-prefix>")?;
let path = derive::derive_path(&session, &derive::DeriveConfig::default());

The forward pipeline is EventReader::read_session_dir → provider::to_view (producing a toolpath_convo::ConversationView) → the shared toolpath_convo::derive_path. The derived Path carries the agent-coding-session kind, per-turn tool invocations classified into toolpath’s ToolCategory ontology, and — for file writes whose args carry full content — a raw unified-diff perspective.

Status & limitations

• Both directions. Forward (path p import/list/show copilot, path share) and reverse via CopilotProjector (path p export copilot, path resume). Resume writes ~/.copilot/session-state/<id>/ + a session-store.db sessions row (only ever a fresh id). ✅ Verified against copilotVersion 1.0.67: a projected session loads and resumes in the real copilot --resume. The loader’s writer requirements (UUID ids, offset ISO timestamps, turnId, messageId, …) are documented in writing-compatible.md.
• File fidelity is best-effort. Copilot records file edits as tool-call args plus separate checkpoints//rewind-snapshots/ rather than inline diffs (unlike Codex). This crate synthesizes a raw diff when the tool args contain full file content; edit-shaped calls without the full file yield a structural change only. Snapshot-based diff reconstruction is deferred.
• Token accounting sums per-message outputTokens for the session output total (falling back to session.shutdown when present); no per-turn attribution, and no input-token total observed in an open session.

See the known-gaps doc for the full list and the checklist to run once a real session is captured.

License

MIT

Re-exports

pub use error::ConvoError;

pub use error::Result;

pub use io::ConvoIO;

pub use paths::PathResolver;

pub use reader::EventReader;

pub use types::CopilotEvent;

pub use types::EventLine;

pub use types::MessageEvent;

pub use types::Session;

pub use types::SessionMetadata;

pub use types::SessionShutdown;

pub use types::SessionStart;

pub use types::Subagent;

pub use types::ToolExecution;

pub use types::Workspace;

pub use types::parse_workspace;

pub use provider::CopilotConvo;

pub use provider::PRODUCER_NAME;

pub use provider::PROVIDER_ID;

pub use provider::native_name;

pub use provider::to_view;

pub use provider::tool_category;

pub use project::CopilotProjector;

Modules

derive

Derive Toolpath documents from GitHub Copilot CLI sessions.

error

io

Higher-level filesystem operations over PathResolver.

paths

Filesystem layout for GitHub Copilot CLI state.

project

Project a provider-agnostic ConversationView into a Copilot CLI Session (an events.jsonl line stream + workspace metadata).

provider

Build a provider-agnostic ConversationView from a Copilot Session.

reader

Read a Copilot CLI session directory into a Session.

types

Typed model of the Copilot CLI events.jsonl stream.