Skip to content

Installation

Add amethystate to your Cargo.toml:

[dependencies]
amethystate = "*"

amethystate requires a storage backend. The default is redb.

redb — the default. A fast embedded database.

amethystate = "*"

Text — human-readable files. Three formats are available: json, toml, and ron. Useful for debugging, when human-editable storage is required, or as a migration path from existing solutions like confy or custom file-based storage.

amethystate = { version = "*", default-features = false, features = ["json"] }

SQLite — via rusqlite. Use sqlite-bundled if you don’t want a system SQLite dependency.

amethystate = { version = "*", default-features = false, features = ["sqlite-bundled"] }

Tauri integration includes a plugin, async backend, and Rust and TypeScript bindings generator. Enable it with the tauri feature:

amethystate = { version = "*", features = ["tauri"] }

See Tauri integration for setup and usage.

See Migrating from confy or Migrating from a custom solution.

See Integrations.