FAQ

Questions people should ask before trusting a security tool.

ArkheionX is intentionally cautious: it organizes review context, but it does not produce final security conclusions.

What is ArkheionX?

ArkheionX is local-first review infrastructure for Solidity and Foundry projects. It helps turn a repository into structured review context.

What is a review map?

A review map is organized context about contracts, roles, value paths, assumptions, test gaps, evidence links, fixture output, and drift.

Who is ArkheionX for?

It is for security researchers, audit teams, protocol engineers, and developers preparing a smart contract system for review.

What command should I run first?

Run arkheionx review-map . on a repository you are authorized to review. Run version and doctor first to confirm your install and environment.

Why does review-map exit with code 1?

Exit code 1 means review guidance is present — there is something to inspect. It is intentional, not a crash. Exit 0 means nothing was surfaced; exit 2 is a usage or input error.

What does the Source: file:line reference mean?

Each test gap prints the exact file and line of the function it refers to, taken from the parsed source so you can open it directly. It is not an invented number.

Can I use ArkheionX for bug bounty?

Yes, as a triage and hypothesis workbench on authorized targets only. It does not confirm vulnerabilities or submit reports, so validate manually before any submission.

What if my repo is not a Foundry project?

review-map still maps the Solidity sources it can parse; doctor will note that no Foundry project was detected. Foundry is recommended for the test-coverage and proof steps.

What is stable in V4?

V4 stabilizes the local review-map workflow: version, doctor, review-map, value-paths, assumptions, test-gap-map, and proof-plan. Source-tree commands like scan, test-plan, and search are advanced.

Is ArkheionX an auditor?

No. ArkheionX supports review work, but it is not an auditor and does not stand in for human security review.

Does ArkheionX find vulnerabilities?

It can help organize evidence and suspicious review surfaces, but it does not provide final vulnerability confirmation.

Does ArkheionX assign severity?

No. Severity requires human analysis, protocol context, impact assessment, likelihood, and validation.

Does ArkheionX prove a protocol is safe?

No. It does not prove safety. It helps preserve context that a human reviewer can inspect.

Does it replace Slither?

No. ArkheionX is not a replacement for static analyzers. It is a review-context layer around a codebase.

Does it replace Foundry?

No. Foundry is a development and testing toolchain. ArkheionX is focused on review maps and deterministic context.

Does it replace fuzzing?

No. Fuzzing remains useful. ArkheionX can help organize what is tested, what is assumed, and where gaps may remain.

Does ArkheionX run exploit code?

No default public workflow should be treated as exploit execution. It is designed around local review context.

Does it call RPC endpoints?

No RPC is required by default for the public local-first workflow.

Does it need private keys?

No. Default workflows do not require private keys, seed phrases, or wallet credentials.

Can I use it on private repositories?

Yes, if you have permission. The local-first design is intended to support private review workflows.

What does local-first mean?

It means the primary workflow starts from files and execution on your machine rather than a hosted dashboard or live-chain connection.

What does deterministic mean here?

It means outputs should be stable and reproducible when inputs and configuration have not changed.

What are source fingerprints?

Source fingerprints are deterministic identifiers for local source inputs, used to help track whether reviewed inputs changed.

What is snapshot drift?

Snapshot drift is a change between expected deterministic output and newly generated output.

What is a fixture benchmark?

A fixture benchmark is a local/static protocol shape used to test output consistency and review-surface behavior.

Why use fixtures?

Fixtures make behavior easier to compare because they avoid relying on live external systems during benchmark checks.

What examples does ArkheionX model?

Examples include token-like systems, lending vaults, staking rewards, AMM swaps, oracle-dependent vaults, proxies, bridge messages, liquidation engines, and timelocks.

Is the installer production-final?

The public install path is source-based. Promotion should wait until fresh install validation and package checks pass.

Why no binary release yet?

Binary releases are planned but not published. The current distribution path is source install from GitHub main.

How do I install?

Use the install page. The direct source command is curl -fsSL https://arkheionx.dev/install.sh | bash.

Should I inspect the installer first?

Yes, especially on first use. Download the script, read it locally, then run it if you accept its behavior.

How do I update?

Re-run the source installer, then verify with arkheionx version.

How do I uninstall?

Remove the managed ~/.arkheionx directory and the ~/.local/bin command wrappers created by the installer.

What if arkheionx command is not found?

Make sure $HOME/.local/bin is in your PATH, then restart your terminal.

What Python version is required?

Python 3.11 or newer is required for the source install path.

What if Git is missing?

Install Git with your operating system package manager, then rerun the installer.

What does arkheionx version check?

It confirms that the command wrapper and installed package can start.

What does arkheionx doctor check?

It is intended to help inspect the local environment and identify setup issues.

Can ArkheionX generate reports?

It can help organize review context, but final reports should be written and validated by humans.

Can it be used during an audit?

It can support review workflows if the team chooses to use it, but it does not replace the audit process.

Can it support responsible disclosure?

It can help organize evidence, but disclosure decisions and report contents require human validation.

Can I submit tool output as a final report?

No. Treat tool output as context. Verify manually and write the final report outside automation.

Does ArkheionX require a hosted dashboard?

No. The public workflow is local-first.

Does ArkheionX collect telemetry?

The website and local workflow should avoid external analytics and tracking by default.

Is ArkheionX open source?

Yes. ArkheionX is licensed under Apache-2.0 (see the LICENSE file in the repository). The v8.0.0 source is on GitHub.

What should I read next?

Read Getting Started, Installation, Quickstart, Concepts, Fixture Harness, Determinism, and Safety Model.

Safety boundary

Review context is not a security verdict.

ArkheionX outputs must be inspected and validated by humans before any security conclusion, disclosure, report, or protocol decision.

Read safety model