Skip to content
agentvfs ★ GitHub
beginner 5 minutes

Install agentvfs

agentvfs ships as a native Rust crate plus npm and pip wrappers. Pick the one that fits your stack; all three give you the same avfs CLI.

  1. 1

    Install the CLI

    Use cargo for the native crate, or the npm / pip wrapper (both fetch the matching native binary).

    cargo install agentvfs   # or: npm i -g agentvfs-cli   # or: pip install agentvfs-cli
  2. 2

    Create a vault

    Create a single-file workspace. It lives at ~/.avfs/vaults/<name>.avfs on the SQLite backend by default.

    avfs vault create demo
  3. 3

    Confirm it works

    List your vaults as JSON to verify the install and see the workspace you just created.

    avfs vault list --json

Backend notes

  • ▸SQLite is the recommended production backend and the default.
  • ▸Sled and LMDB are pluggable via feature flags (sled-backend, lmdb-backend) but do not yet have atomic transaction wrappers.
  • ▸The pip wrapper caches the binary under ~/.cache/agentvfs/<version>/; AGENTVFS_BIN overrides the path.

More guides in the index, or read the architecture to see what the boundary is doing.