Skip to content

installation.md

Latest commit

 

History

History
210 lines (136 loc) · 4.13 KB

installation.md

File metadata and controls

210 lines (136 loc) · 4.13 KB

Installation

This guide installs ProofLog and gets to a first local proof report.

Requirements

  • Git
  • Local Codex JSONL history, usually under ~/.codex

Source installs also require Rust 1.80 or newer.

ProofLog is currently validated around macOS and Linux-style local paths. Windows support has not been validated yet.

ProofLog stores data locally in SQLite. It does not upload Codex history, git state, command output, or reports.

Install With Homebrew

Homebrew is the intended release channel:

brew tap malikdraz/tap
brew install prooflog

Verify the install:

prooflog --help

The first Homebrew release is being prepared. Until the tap formula is published, use the source install below.

Install From Source

git clone https://github.com/malikdraz/prooflog.git
cd prooflog
cargo install --path .

Confirm the binary is on your PATH:

prooflog --help

If your shell cannot find prooflog, check that Cargo's bin directory is on your PATH. It is usually:

$HOME/.cargo/bin

Crates.io Package

This command is planned, but is not available yet:

cargo install prooflog

Use Homebrew or cargo install --path . from this repository until a crates.io package is published.

First Report

From the repository you want to inspect:

prooflog init
prooflog doctor
prooflog ingest --codex --codex-root ~/.codex
prooflog proof --since main

If your Codex history is somewhere else, pass that path explicitly:

prooflog ingest --codex --codex-root /path/to/codex-history

If you want to run the proof command from outside the target repository, pass --repo:

prooflog proof --since main --repo /path/to/repo

Output Formats

Plain text is the default:

prooflog proof --since main

Markdown is useful for PRs:

prooflog proof --since main --format md > prooflog.md

JSON is available for tooling experiments:

prooflog proof --since main --format json > prooflog.json

Local Files

ProofLog stores its local config and SQLite database under one app-owned directory:

$HOME/.prooflog/config.toml
$HOME/.prooflog/prooflog.db

If HOME is not set, ProofLog falls back to USERPROFILE for Windows-style environments.

You can override the database path when needed:

prooflog init --db /path/to/prooflog.db
prooflog doctor --db /path/to/prooflog.db
prooflog proof --since main --db /path/to/prooflog.db

Troubleshooting

cargo Is Missing

Install Rust with rustup, then reopen your shell:

rustup --version
cargo --version

ProofLog requires Rust 1.80 or newer.

prooflog Is Not Found

Check Cargo's bin directory:

echo "$PATH"
ls "$HOME/.cargo/bin/prooflog"

Add $HOME/.cargo/bin to your shell PATH if needed.

run prooflog init

doctor, ingest, and proof expect local config and storage. Start with:

prooflog init

Codex Root Is Missing

Run:

prooflog doctor

If the default Codex root is missing, ingest with an explicit path:

prooflog ingest --codex --codex-root /path/to/codex-history

Not Inside A Git Repository

Run prooflog proof from the repository you want to inspect, or pass --repo:

prooflog proof --since main --repo /path/to/repo

Invalid Base Ref

--since must be a valid git ref in the target repository. Common examples:

prooflog proof --since main
prooflog proof --since origin/main
prooflog proof --since HEAD~1

Permission Warnings

On Unix-like systems, ProofLog expects local config and DB files to be owner-readable/writable only. If doctor reports broad permissions, follow the printed chmod 600 command.

No Relevant Evidence

If the proof report is UNKNOWN, run verification commands from the target repository, ingest Codex history again, then rerun proof:

prooflog ingest --codex --codex-root ~/.codex
prooflog proof --since main

Parser Diagnostics

For count-only parser health checks:

prooflog doctor --parser

This does not print raw transcript text, raw JSONL content, command output, or parse error text.