Skip to main content

Getting Started

Install#

Homebrew#

The recommended way to install snip on macOS is via Homebrew.

$ brew install sniptt-official/snip/snip

npm#

Alternatively, you can also install snip via npm.

$ npm install sniptt -g

Manual#

For manual installation instructions on macOS and Linux, please refer to the dedicated install docs.

Basic Usage#

Setup#

Create a new account or configure a new device with an existing account.

$ snip configure

For advanced usage, type snip configure -h.

Add secrets#

Add end-to-end encrypted secrets to your personal vault.

# Add simple key/value.$ snip add DB_PASSWORD AYYGR3h64tHp9Bne
# Add simple key/value (you will be prompted using hidden password input).$ snip add DB_PASSWORD
# Add file.$ snip add --file .env.prod

For advanced usage, type snip add -h.

Read secrets#

Read end-to-end encrypted secrets from your personal vault.

# Read simple value.$ snip get DB_PASSWORD
# Read a file.$ snip get .env.prod
# Download a file.$ snip get .env.prod -o .env.prod
# Get started with automation.$ snip get .env.prod -q --json | jq -r .SecretContent | base64 -d

For advanced usage, type snip get -h.

Vaults#

Vaults allow you to store and share secrets with others.

# Create a new vault.$ snip vault create creds:aws
# Add a member to a vault.$ snip vault add-member creds:aws -e alice@example.com
# Add a secret to a vault.$ snip add -f sandbox.csv -v creds:aws
# Automate workflows.$ snip vault ls -q --json | jq -r ".[].VaultId" | pbcopy

For advanced usage, type snip vault -h.

Sharing#

Share an end-to-end encrypted secret via a one-time URL.

# Create one-time secret.$ snip share AYYGR3h64tHp9Bne
# Create one-time secret from a file.$ snip share --file .env.local

For advanced usage, type snip share -h.