Getting Started

There's really nothing to getting Cassi up and running, other than selecting a root directory for your vault storage and setting a password for each vault. Have a look at how easy it is to create a Cassi Vault:

// Import Cassi
const cassi = require('cassi')

// Create a new vault instance
const vault = new cassi.Vault({ name: 'my-vault' })

// Create the vault with password 'hello'
vault.create('hello')
      .then(({ vault, mnemonic }) => {
        // Good stuff, enjoy your new vault
        // Store the mnemonic somewhere safe
      })
      .catch((error) => {
        // Something happened and the vault could not be created
      })

Documentation

Cassi is very well documented and all objects, options, fields and functions are well explained and they all include examples.

Read the full documentation for detailed instructions on how to create, lock, unlock vaults and how to read and write sensitive data.

Read The Docs

Contributing

We'd be glad to have you join us as an Cassi Contributor. Get started by reading our Contributor Guide.

Read The Contributor Guide

Dependencies

Cassi makes use of the following libraries:

• lowdb - for storage
• fs-extra - for file management
• uuid - for generating ids
• bip38 - for encrypting the machine secret
• bip39 - for generating mnemonics
• bitcoinjs-lib - for generating keys
• keytar - for working with the system keychain
• wif - for decoding machine secrets

License

Cassi is licensed under the MIT License.

• Read The License

Sponsors

Cassi is sponsored by Fluid Trends and is part of the Fluid Trends Open Source Lab.

If you'd like to co-sponsor this project, please email your co-sponsorship request to team at fluidtrends.com