Setup

Installation

Install Canon from crates.io:

cargo install canon-archive

This installs the canon binary.

From Source

Alternatively, build from source:

git clone https://github.com/robklg/canon.git
cd canon
cargo install --path .

Database

Canon stores all state in a SQLite database. The default location is ~/.canon/canon.db.

You can override this with the --db flag:

canon --db /path/to/custom.db scan ...

The database is created automatically on first use. It contains:

• Registered roots and their scan state
• All indexed sources with metadata
• Content hashes and object references
• Imported facts from enrichment

Verify Installation

canon --help

You should see the list of available commands. You’re ready to start scanning your files.