bwsf

v0.16.0

はじめに

bwsfとは?

bwsf は、Bitwarden を使用して .env* や Terraform の *.tfvars / *.tfvars.json といったプロジェクトファイルを安全に管理する CLI ツールです。

メールや Slack のような安全でないチャネルで秘密情報を共有する代わりに、bwsf を使えば Bitwarden ボールトに保存してチーム間で同期できます。

前提条件

bwsf を使用する前に、以下を準備してください:

  1. Bitwarden アカウント - Bitwarden Cloud またはセルフホスト Bitwarden サーバー
  2. Bitwarden CLI (bw) - 公式の Bitwarden コマンドラインツール

Bitwarden CLI のインストール

公式 Bitwarden CLI インストールガイドに従って、お使いのマシンに bw コマンドをインストールしてください。

インストールの確認:

bw --version

bwsf の仕組み

bwsf は管理対象ファイルを Bitwarden フォルダ(デフォルト名: dotenvs)内の ノートアイテム として保存します。構造のイメージは以下のとおりです:

Bitwarden Vault
└── dotenvs/                    # bwsf 用デフォルトフォルダ(変更可能)
    ├── my-web-app              # プロジェクト名 = カレントディレクトリ名
    │   ├── .env
    │   ├── .env.staging
    │   ├── .env.production
    │   └── terraform.tfvars
    └── another-project
        └── .env

::: info デフォルトのフォルダ名は dotenvs です。bwsf setup --folder <name> で変更できます。名前変更では既存ノートは移動しません。 :::

初期設定

bwsf をインストールしたら、セットアップコマンドを実行します:

bwsf setup

これにより以下が設定されます:

  • Bitwarden サーバー URL(セルフホストインスタンスの場合)
  • Bitwarden アカウントの認証情報

保存内容はいつでも次で確認できます:

bwsf config show

次のステップ

  • インストール - お使いのプラットフォーム向けのインストール手順
  • コマンド - 利用可能なすべてのコマンドを学ぶ