ProofPack v1.0.0 · Released · Documentation

Local-first evidence, documented plainly.

This compact guide describes the implemented ProofPack v1.0.0 workflow. Distribution is public documentation plus request access; there is no public ZIP or public source repository.

01

Overview

ProofPack compiles operator-supplied structured inputs and reviewed artifacts into a local evidence bundle. It validates the project and scans projected public text and artifact names; it does not invent, attest, certify, notarize, or independently verify facts.

02

Request access and prerequisites

After receiving the ProofPack package from NX Warden, extract it to a local working folder. You need Python 3.10 or newer and Jinja2 from the included requirements.txt.

python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
.\.venv\Scripts\python.exe generator.py --version

03

Quick start

Use the included fictional Acme Relay project to inspect the complete workflow without using customer or NX Warden operating data.

.\.venv\Scripts\python.exe generator.py doctor --project examples\fictional\acme-relay
.\.venv\Scripts\python.exe generator.py check --project examples\fictional\acme-relay
.\.venv\Scripts\python.exe generator.py build --project examples\fictional\acme-relay --generated-at 2030-01-02T03:04:05+00:00
.\.venv\Scripts\python.exe generator.py preview --project examples\fictional\acme-relay

04

Commands

version.\.venv\Scripts\python.exe generator.py --version
init.\.venv\Scripts\python.exe generator.py init --output projects\my-project
doctor.\.venv\Scripts\python.exe generator.py doctor --project examples\fictional\acme-relay
check.\.venv\Scripts\python.exe generator.py check --project examples\fictional\acme-relay
build.\.venv\Scripts\python.exe generator.py build --project examples\fictional\acme-relay
preview.\.venv\Scripts\python.exe generator.py preview --project examples\fictional\acme-relay

05

Inputs

A project supplies structured seed data, service notes, boundaries, roadmap and founder/operator notes, plus an artifacts folder. Stage only material already reviewed as safe for the intended audience.

ProofPack does not read the repository-level private quarantine while building a public project.

06

Outputs

The build command writes these local bundle entries.

proofpack.htmlproofpack.mdcompliance_checklist.jsonartifact_manifest.jsonbuild_report.jsonbuild_report.mdchecksums.sha256artifacts/

07

Privacy model

ProofPack runs locally and writes to a local project folder. It does not upload source material or generated bundles. Publishing and sharing remain deliberate operator actions.

08

Fictional demo

Acme Relay is fictional and is not a customer or client engagement. Its identities, domains, timestamps, infrastructure, and artifacts are documentation-safe demonstration data.

09

Limitations

A passing scan only means configured checks did not find a known pattern. Binary artifacts require human review. ProofPack is not an auditor, attestation service, compliance certification, or substitute for qualified review.

10

Security reporting

Report a reproducible security issue through the NX Warden contact path. Use fictional inputs when possible and do not send passwords, API tokens, private keys, or raw credentials by email.

11

Versioning

These docs cover ProofPack v1.0.0, released through public documentation and request access. The package remains local-first; no public ZIP download or public source repository is available.