Quick start
Record your first Attestack session in a few minutes.
Prerequisites
Section titled “Prerequisites”| Requirement | Notes |
|---|---|
| Shell | Linux, macOS, or Windows |
| Git | Required for snapshot; recommended for real projects |
| Rust (optional) | Only if building from source |
Install
Section titled “Install”curl -fsSL https://raw.githubusercontent.com/kiket-dev/attestack/main/scripts/install.sh | bashSee the Installation guide for manual downloads or building from source.
Regenerate locally: ./scripts/render-demos.sh (requires VHS).
Walkthrough
Section titled “Walkthrough”1. Initialize a project
Section titled “1. Initialize a project”Create a Git repo and initialize Attestack in it:
mkdir my-project && cd my-projectgit init -b mainecho "hello" > README.mdgit add README.md && git commit -m "init"
attestack initattestack doctor2. Start a session
Section titled “2. Start a session”Open a session with a descriptive title. Attestack captures an initial Git snapshot when inside a repo:
attestack start "demo session"attestack status3. Record work
Section titled “3. Record work”Run commands, add notes, and capture Git state as you go:
attestack run -- echo helloattestack note "Reviewed generated change"attestack snapshot4. Close and review
Section titled “4. Close and review”Stopping the session writes a Markdown report under .attestack/sessions/<id>/reports/:
attestack stopattestack report5. Export and verify
Section titled “5. Export and verify”Create a signed bundle and verify it offline:
attestack bundle createattestack verify .attestack/bundles/*.attestack.zipScripting with JSON
Section titled “Scripting with JSON”Most commands accept --json for automation:
attestack status --jsonattestack verify .attestack/bundles/demo.attestack.zip --jsonattestack doctor --jsonNext steps
Section titled “Next steps”- Installation — release binaries and install script
- Use cases — who Attestack is for and why
- CI integration — GitHub Actions and generic CI
- Agent guide —
attestack agentand MCP server - CLI reference — every command, flag, and exit code
- Data model — sessions, events, and bundles
- Security model — keys, privacy, and verification