Quickstart

1. Install the CLI

curl -fsSL https://raw.githubusercontent.com/axiom-vault/axiom-cli/main/install.sh | bash

Other install paths include GitHub Releases, Homebrew, and building from source.

2. Create a vault

axiom vault create --name MyVault --path ~/my-vault

3. Add a file

axiom file add \
  --vault-path ~/my-vault \
  --source ~/secret.pdf \
  --dest /secret.pdf

4. Inspect contents

axiom file list --vault-path ~/my-vault

5. Extract a file

axiom file extract \
  --vault-path ~/my-vault \
  --source /secret.pdf \
  --dest ~/secret.pdf

6. Open an interactive session

axiom vault open --path ~/my-vault

Optional: enable sync

axiom sync run --vault-path ~/my-vault --strategy keep-both
axiom sync status --vault-path ~/my-vault

Optional: mount the vault

mkdir -p ~/my-vault-mount
axiom mount fuse --path ~/my-vault ~/my-vault-mount

Build from source

git clone https://github.com/axiom-vault/axiom-cli.git
cd axiom-cli
cargo build --release