1Password for VS Code は、 1Password CLIを活用して開発ワークフローを 1Password と統合するためのツール セットを提供します。

必要条件

VS Code 拡張機能を使う前に、次のことを行う必要があります。

• Mac、Windows、またはLinux用の 1Password をインストールします。
• 1Password CLIの最新バージョンをインストールします。
• 1Password CLI を 1Password アプリと統合します。

インストール

1Password for VS Code 拡張機能は、VS Code Marketplace または GitHub からインストールできます。 

VS Code マーケットプレイス 

1Password for VS Code 拡張機能をインストールする最適な方法は、拡張機能を自動的に最新の状態に維持する VS Code Marketplace を使うことです。 

マーケットプレイスからインストール 

GitHub 

1Password for VS Code を GitHub から直接インストールすることもできます。このオプションは、自動更新を望まない、または拡張機能の古いバージョンを使う場合に適しています。GitHub リリース ページには、以前のリリースがすべてリストされています。 

リリースにはVSIXファイルが含まれていますVS Code にインストールできます。 

GitHubからインストール 

インストール後、拡張機能により 1Password アカウントと保管庫を選択するように求められます。 注意 拡張機能の機能を使うには、1Password アカウントと保管庫を選択する必要があります。 コマンドパレットからアカウントと保管庫を後で選択できます:

• ①Command Paletteを開きます。
• ②1Password アカウントを選択するために、1Password: Choose account を入力します。
• ③Vault を選択するために、1Password: Choose vaultを入力します。

Extension settings

1Password for VS Code には、構成できる設定がいくつかあります。1Password for VS Code の設定にアクセスするには:

• ①Code > Preferences > Settingsに移動します。
• ②1Passwordまでスクロールするか、検索します。

次の表に拡張機能の設定を示します。

Feature

コードからシークレットが漏洩するのを防ぐ最善の防御策は、最初からシークレットをコード内に含めないことです。これを支援するため、シークレット参照を導入しました。VS Code 用 1Password は、シークレット参照を念頭に置いて構築されています。VS Code でシークレット参照を簡単に使用できるようにするための方法については、さらに詳しく、また、以下をお読みください。 

デフォルトでは、全ての操Createでアイテム フィールドを取得およびSaveするときにシークレット参照が使用されます。シークレット参照を使用しない場合は、「アイテム: シークレット参照を使う」設定をオフにして、代わりに生のフィールド値を挿入または保持することができます。 

1Password VS Code プラグインを使うと、次のことが可能になります。

• 1PasswordにSave
• 秘密の検出
• 1Passwordから値を取得する
• 秘密をCreateする
• 秘密の参照をプレビューする
• 1Passwordの秘密を公開

Save in 1Password

1Password 拡張機能を使うと、ドキュメント内のコードから 1PasswordにアイテムをSaveできます。

• ①ファイル内の公開されたシークレットを選択します。
• ② Command Paletteを開く。
• ③1Password: Save in 1Passwordを入力。
• ④アイテムの名前を入力します。

拡張機能は、各選択肢からアイテム名とフィールドを入力するように求めます。フィールド ラベルが電子メール、URL、またはクレジットカードのように見える場合は、自動的に推測しようとします。 アイテムをCreateして 1PasswordにSaveすると、拡張機能は選択内容をそのアイテムとフィールドを指す秘密の参照に置き換えます。 ヒント コマンドパレットを開く前にファイル内の複数の項目を選択すると、複数の項目を同時にSaveできます。VS Code での複数選択について詳しくは、こちらをご覧ください。

Detect secrets

1Password for VS Code は、秘密のように見えるコードを自動的に監視し、1PasswordにSaveすることを提案します。動作は通常のファイルと .envファイルで若干異なります。

• 全ての通常ファイルにわたって既知の秘密パターンに一致する文字列をチェックします。
• ファイル内のキーワードを検査し.env、値が秘密であるかどうかを推測します。

拡張機能が一致するものを見つけると、"Save in 1Password" CodeLensが表示されます。クリックすると 1Passwordに秘密をSaveできる行の上にあります。 この機能は、"Editor: Suggest Storage"設定で制御できます。

Get values from 1Password

1Password for VS Code 拡張機能を使うと、コード内で 1Passwordに既に存在する値を使用できます。

• ① Command Paletteを開く。
• ②1Password: Get from 1Passwordを入力。
• ③アイテム名またはUUIDを入力します。
• ④使うフィールドを選択します。

拡張機能は、その項目とフィールドを指す秘密の参照を挿入します。 ヒント 使う保管庫、アイテム、フィールドが既にわかっていますか?secret referenceまたは op://と入力してください。拡張機能には、秘密参照の個々の部分を入力するためのコード スニペットが用意されています。

Create secrets

VS Code からプロジェクトのシークレットをCreateできます。

• ①文書内にカーソルを置きます。
• ②Command Paletteを開く。
• ③コマンドパレットに1Password: Generate passwordを入力します。
• ④アイテムの名前を入力してください。

1Password VS Code 拡張機能は、ランダムに生Createされたパスワードを使用してアイテムをCreateし、そのアイテムとフィールドを指す秘密参照をドキュメントに挿入します。 ヒント 「エディター: パスワード レシピ」設定を使用して、1Password for VS Code がパスワードの生Createに使うレシピをカスタマイズできます。

Preview secret references

1Password for VS Code は、開いているドキュメントを分析して秘密の参照を探し、見つかった秘密の参照に下線を付けます。また、個々の秘密の参照をプレビューしたり、秘密の参照値をファイルに読み込んだりすることもできます。 シークレット参照の詳細を検査するには:

• ①秘密参照の上にカーソルを置きます。秘密参照の詳細がVS Code CodeLensに表示されます。 CodeLensウィンドウには、Create日など、シークレットに関する機密性のない情報のみが表示されます。機密性の高いフィールド (パスワードや SSH鍵など) の値は表示されません。

秘密の参照が実際の値に変換されたファイルの外観をプレビューするには:

• ①ドキュメントの右上にあるロック解除アイコンを選択します。 これにより、秘密の参照が実際の値に置き換えられたドキュメントの未Saveのコピーが開き、Saveまたは削除できるようになります。

TIP "1Password: Preview with secrets"コマンドを使用して、コマンドパレットからファイルのシークレットを表示することもできます。

Open secrets in 1Password

1PasswordアプリでOptionキーを押したままにすると、秘密の参照を開くことができます。、秘密の参照を選択します。 または、秘密の参照の上にカーソルを置き、CodeLensウィンドウでFollow linkを選択することもできます。

Contributing and feedback

1Password for VS Code はオープンソース プロジェクトです。 問題を発見した場合やフィードバックを共有したい場合は、GitHub の問題を開いてください。 誰でも拡張機能に貢献できます。貢献ガイドラインを参照してください。詳細についてはこちらをご覧ください。