Quickstart
Run the smallest useful ArkheionX workflow.
Start by verifying the installed command and local environment. Keep the first workflow boring, inspectable, and easy to debug.
1. Install from source
curl -fsSL https://arkheionx.dev/install.sh | bash For first use, inspect the script before running it.
curl -fsSL https://arkheionx.dev/install.sh -o arkheionx-install.sh
less arkheionx-install.sh
bash arkheionx-install.sh 2. Check the installed command
arkheionx version This confirms that the wrapper is available and that the installed package can start.
3. Check the environment
arkheionx doctor The doctor command should be the first place to look when something feels wrong locally.
4. Build the review map
arkheionx review-map .
This is the core command. It maps value paths, trust assumptions, and missing tests, and
writes artifacts under .arkheionx/out/review-map/. Try the bundled
multi-contract demo first:
arkheionx review-map examples/vault-strategy-oracle-fixture 5. Read the safety model
ArkheionX creates review context. It does not confirm vulnerabilities, assign final severity, prove protocol safety, submit reports, or stand in for human review.
Open safety model6. Read the focused views
Each view is a focused slice of the same review map. They read the artifacts
review-map wrote, or derive them in memory.
arkheionx value-paths .
arkheionx assumptions .
arkheionx test-gap-map .
arkheionx proof-plan . test-gap-map prints a Source: <file>:<line> for each gap so
you can open the exact function. See
how it works for the full pipeline.
7. What comes next
Use ArkheionX as a structured review layer around your codebase. Treat outputs as review context that must be inspected by a human. Next: the bug bounty and pre-audit workflows.