Getting Started

What is bwsf?

bwsf is a CLI tool that uses Bitwarden to manage .env files securely.

Instead of sharing .env files through insecure channels like email or Slack, bwsf lets you store them in your Bitwarden vault and sync them across your team.

Prerequisites

Before using bwsf, make sure you have:

1. Bitwarden Account - Either Bitwarden Cloud or a self-hosted Bitwarden server
2. Bitwarden CLI (bw) - The official Bitwarden command-line tool

Installing Bitwarden CLI

Follow the official Bitwarden CLI installation guide to install the bw command on your machine.

Verify the installation:

bw --version

How bwsf Works

bwsf stores your .env files in a special folder called dotenvs within your Bitwarden vault. Here's how the structure looks:

Bitwarden Vault
└── dotenvs/                    # Reserved folder for bwsf
    ├── my-web-app/             # Project name (directory name)
    │   ├── .env
    │   ├── .env.staging
    │   └── .env.production
    └── another-project/
        └── .env

INFO

By default the folder name is dotenvs. You can change it with bwsf setup --folder <name>. Changing the name does not move existing notes.

Initial Setup

After installing bwsf, run the setup command:

bwsf setup

This will configure:

• Your Bitwarden server URL (for self-hosted instances)
• Your Bitwarden account credentials

Next Steps

• Install bwsf - Installation instructions for your platform
• Commands - Learn all available commands