# レコードに関するコマンド ## コマンド 対話型シェル、CLI、JSON構成ファイルのいずれを使用する場合でも、以下のレコードコマンドがサポートされています。各コマンドには追加のパラメーターやオプションを指定できます。 特定のコマンドのヘルプを表示するには、以下のコマンドを実行します。 `help ` | コマンド | 説明 | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | | [`list`または`l`](#list-command) | すべてのレコードを一覧表示するか、または正規表現を使用して検索します。 | | [`search`または`s`](#search-command) | 正規表現を使用してすべてのレコードを検索します。 | | [`ls`](#ls-command) | フォルダの内容を一覧表示します | | [`tree`](#tree-command) | フォルダ構造全体をツリー表示します | | [`cd`](#cd-command) | 現在のフォルダを変更します | | [`get`または`g`](#get-command) | 印刷可能形式またはJSON形式でKeeperレコード、フォルダ、チームを取得して表示します | | [`find-password`](#find-password-command) | 指定したKeeperのレコードのパスワードフィールドをシステム出力に表示します | | [`clipboard-copy`](#clipboard-copy-command) | 指定したKeeperレコードのパスワードフィールドをクリップボードにコピーするかstdoutに送信します | | [`record-history`または`rh`](#record-history-command) | 履歴またはレコードの変更を表示します | | [`totp`](#totp-command) | 指定したレコードの二要素コードを表示するか、レコードが指定されていない場合は、二要素コードを含むレコードの一覧を表示します | | [`download-attachment`](#download-attachment-command) | 指定したレコードのすべての添付ファイルをダウンロードします | | [`upload-attachment`](#upload-attachment-command) | 指定したレコードにファイルをアップロードして添付します | | [`delete-attachment`](#delete-attachmant-command) | 指定したレコードから添付ファイルを削除します | | [`file-report`](#file-report-command) | ボルト内でアクセスできるすべてのファイルのレポートを表示します | | [`list-sf`または`lsf`](#list-sf-command) | ボルト内のすべての共有フォルダの詳細情報を表示します | | [`list-team`または`lt`](#list-team-command) | アクセスできるすべてのチームを一覧表示します | | `add`または `a` | 廃止: [`record-add`](#record-add-and-record-update-commands)をご使用ください | | [`record-add`または`ra`](#record-add-and-record-update-commands) | レコードを追加します | | `edit` | 廃止: [`record-update`](#record-add-and-record-update-commands)をご使用ください | | [`record-update`または`ru`](#record-add-and-record-update-commands) | 既存のレコードを編集します | | [`rm`](#rm-command) | レコードを削除します | | [`append-notes`または`an`](#append-noteskomando) | レコードにメモを追加します | | [`mkdir`](#mkdir-command) | フォルダまたは共有フォルダを作成します | | [`rmdir`](#rmdir-command) | フォルダまたは共有フォルダとその内容を削除します | | [`rndir`](#rndir-command) | フォルダ名を変更します | | [`mv`](#mv-command) | レコードまたはフォルダに移動します | | [`ln`](#ln-command) | レコードまたはフォルダ間のリンクを作成します | | [`find-duplicate`](#find-duplicate-command) | 指定した属性やフィールドに基づいて、ボルト内の重複レコードを検索します。 | | [`shortcut`](#shortcut-command) | レコードのショートカットを一覧表示または管理します | | [`transform-folder`](#transform-folder-command) | フォルダを共有フォルダから個人用フォルダに変換します (またはその逆) | | [`trash`](#trash-command) | ごみ箱の削除されたレコードを一覧表示して管理します | | [`password-report`](#password-report-command) | パスワードレポートの表示 | | [`find-ownerless`](#find-ownerless-command) | ボルト内の所有者のいないレコードをリストします (任意で所有権を請求します) | ### listコマンド **コマンド:** `list`または`l` **詳細**: すべてのレコードを一覧表示するか、または正規表現を使用して検索します **スイッチ:** `-v`、`--verbose` 詳細出力 (レコード名が列に対して長すぎる場合) **例:** ``` l l twitter l ^(?!.*FTP).*Azure.*$ ``` 1. すべてのレコードを一覧表示します 2. twitterという文字列を含むすべてのレコードを一覧表示します 3. 文字列「FTP」を含まないすべての「Azure」レコードを一覧表示します (正規表現を使用) ### searchコマンド **コマンド:** `search`または`s` **詳細:** 正規表現を使用してボルトを検索します **パラメータ:** 検索で使用する正規表現 **スイッチ:** `-v`、`--verbose` 詳細出力 `--format <{table, json}>` 出力形式を指定します。 * table – 結果を表形式で表示(デフォルト) * json – 結果をJSON形式で表示 **例:** ``` s dropbox s [0-z]*\.org search dropbox --format json ``` 1. 「dropbox」を含むレコードを検索します 2. 「.org」で終わる数字と文字からなる文字列のみを含むレコードを検索します 3. 「dropbox」という語を含むレコードを検索し、結果をJSON形式で返します。 ### lsコマンド **コマンド:** `ls` **詳細:** フォルダの内容を一覧表示します **スイッチ:** `-l`、`--list` 詳細なリストを表示します `-f`、`--folders` フォルダを表示します `-r`、`--records` レコードを表示します `-v`、`--verbose` 詳細出力 `-R`, `--recursive` サブフォルダの内容を表示します `--format` 出力形式 `{table, csv, json, pdf}` を指定します `--output` 出力ファイルの保存先パスを指定します(「table」形式の場合は無視されます)。 **例:** ``` ls -l ls -r ls -l -r -v ls -R -l "Folder1" ls -l --format json ``` 1. フォルダの内容の詳細なリスト 2. フォルダ内のレコードのみのリスト (サブフォルダなし) 3. レコードの詳細なリストを表示します。表がいびつになっても長いタイトルを表示します 4. 「Folder1」とそのサブフォルダにあるすべてのレコードとフォルダの詳細なリストを表示します 5. JSON形式でのフォルダ内容の詳細な一覧 ### **tree**コマンド **コマンド:** `tree` **詳細:** 指定したフォルダまたは現在の場所 (フォルダを指定しない場合) をルートとして使用し、フォルダ全体の構造をツリーとして表示します **パラメータ:** ツリーのルートとして使用するフォルダのフルパス、UID、または名前 (現在の場所が親フォルダの場合) (オプション) **スイッチ:** `-r`、`--records` ツリー内の各フォルダのレコードを表示します (やや暗めのテキストで表示されます)\ `-s`、`--shares` 共有フォルダの共有権限を表示します (デフォルトでは凡例/略語表に表示される権限の種類を示す記号)\ `-hk`、`--hide-shares-key` 権限の凡例を非表示にします (`--shares`フラグを指定した場合のみ有効)\ `-t`、`--title ` フォルダ構造の表示でオプションのタイトルを表示します\ `-v`、`--verbose` 詳細出力 (名前に加えてレコード/フォルダUIDを表示します) \ **例:** ``` tree tree "Office Codes/" tree --verbose --records --title="My Folder Structure w/ Records (UIDs shown)" tree --shares --hide-shares-key "/Work Folders/Team1" ``` 1. 現在の場所をルートとして使用して、フォルダ全体の構造をツリーとして表示します 2. サブディレクトリ「Office Codes」フォルダをルートとして、フォルダ全体の構造を表示します 3. 「My Folder Structure w/ Records (UIDs shown)」というタイトルのフォルダ構造を表示します。現在の場所をルートとして使用して、各フォルダ内のレコードも (各フォルダ/レコードに対応するUIDも含めて) 表示します 4. 格納されている共有フォルダごとに、共有アクセス権限 (略号で) を持つフォルダ構造を表示します。対応するアクセス権限記号の凡例/略語表は表示されません。表示されるフォルダ構造のルートは、ボルトのルートフォルダにある**Work Folders**という名前のフォルダにある**Team1**という名前のサブフォルダです (この例ではターゲットフォルダのフルパスが指定されているため、このコマンドはどこからでも呼び出せます) ### cdコマンド <a href="#cd-command" id="cd-command"></a> **コマンド:** `cd` **詳細:** カレントディレクトリを変更します **パラメータ:** 移動先の場所 引用符を使用すると、名前にスペースやスラッシュが含まれるフォルダに移動できます。 バックスラッシュ (\\) を使用すると、フォルダ名の引用符をエスケープできます。 **例:** ``` cd social/ cd financial/banks/ cd / cd "folder/with/slashes" cd folder\"with\"quotes ``` 1. カレントディレクトリの「social」という名前のフォルダに移動します 2. 「financial」という名前のフォルダ内の「banks」という名前のフォルダに移動します 3. ボルトのルートに移動します 4. 「folder/with/slashes」という名前のフォルダに移動します 5. 「folder"with"quotes」という名前のフォルダに移動します ### **find-passwordコマンド** <a href="#find-password-command" id="find-password-command"></a> **コマンド:** `find-password` **詳細:** レコードのUIDまたはパスを指定して、指定したKeeperのレコードのパスワードをシステム出力に表示します **パラメータ:** レコードのパスまたはUID **スイッチ:** `--username <USERNAME>` 正規表現 (オプション) を使用してログイン名と照合します。レコードを検索するには、指定されたタイトルまたはUIDも照合する必要があります。 `--output <{`*`clipboard, stdout}`*`>` 出力先を選択します * stdout - システム出力にパスワードを表示します (デフォルト) * clipboard - パスワードをクリップボードにコピーします `-l`、`--login` パスワードの代わりにログイン名を出力します **例:** ``` find-password rvwIBG_ban2VTH64OsnzLn find-password office/Zoom find-password rvwIBG_ban2VTH64OsnzLn --output clipboard find-password social/Twitter -l find-password reddit --username .*second.* ``` 1. 指定されたUIDを持つ特定のレコードのパスワードを表示します 2. 「office」フォルダの「Zoom」というタイトルのレコードのパスワードを表示します 3. 特定のレコードのパスワードをクリップボードにコピーします 4. 「social」フォルダ内の「Twitter」というタイトルのレコードのログインを表示します 5. タイトルが「reddit」で始まり、ユーザー名に「second」が含まれるレコードのパスワードを表示します ### **clipboard-copyコマンド** <a href="#clipboard-copy-command" id="clipboard-copy-command"></a> **コマンド:** `clipboard-copy` **詳細:** 指定したKeeperのレコードのパスワードを、レコードのUIDまたはパスを指定してクリップボードにコピーするか、パスワードをstdoutに送信します。 **パラメータ:** レコードのパスまたはUID **スイッチ:** `--username <USERNAME>` regexを使用してログイン名を照合します。レコードを発見するには、指定されたタイトルまたはUIDも一致する必要があります。 `--output <{`*`clipboard, stdout, stdouthidden, variable}`*`>` 出力先を選択します。 * `clipboard` - 出力値をクリップボードにコピーします (デフォルト) * `stdout` - システム出力に出力値を表示します * `stdouthidden` - システム出力に出力値を表示しますが非表示の状態です * `variable` - Keeper変数に出力値を保存します `-l`、`--login` パスワードの代わりにログイン名を出力します `--field <FIELD NAME>` カスタムフィールドを出力します `--name` Keeper変数名 `-r`、`--revision` レコードのリビジョン `-t`または`--totp` TOTPコードを出力します **例:** ``` clipboard-copy rvwIBG_ban2VTH64OsnzLn clipboard-copy office/Zoom clipboard-copy rvwIBG_ban2VTH64OsnzLn --output stdout clipboard-copy social/Twitter -l clipboard-copy reddit --username .*second.* ``` 1. 指定されたUIDを持つ特定のレコードのパスワードをクリップボードにコピーします 2. 「office」フォルダの「Zoom」というタイトルのレコードのパスワードをクリップボードにコピーします 3. 指定されたUIDを持つ特定のレコードのパスワードを表示します 4. 「social」フォルダ内の「Twitter」というタイトルのレコードのログインをクリップボードにコピーします 5. タイトルが「reddit」で始まり、ユーザー名に「second」が含まれるレコードのパスワードをクリップボードにコピーします ### **getコマンド** <a href="#get-command" id="get-command"></a> **コマンド:** `get` または `g` **詳細:** 対応するUIDを指定して、印刷可能形式またはJSON形式でKeeperレコード、フォルダ、チームを取得して表示します。 **パラメータ:** レコード、フォルダ、またはチームのUID **スイッチ:** `--unmask` 伏せ字項目の内容をプレーンテキストとして表示します `--format<{`*`detail, json, password}`*`>` 出力の形式を選択します * detail - レコード/フォルダ/チームの詳細表示 (デフォルト) * json - JSON形式の構造 * password - パスワードのみ `--include-dag` JSON形式が指定された場合に、関連する管理用認証情報UIDや接続用認証情報UIDなどの追加PAMレコードデータを含めます。 `--legacy` JSON出力のみ。タイプ指定のあるレコードをレガシーJSON形式で表示します。 **例:** ``` get rvwIBG_ban2VTH64OsnzLn g rvwIBG_ban2VTH64OsnzLn --format json --legacy get E8pikwH-yUAfTQJZ2bezbQ --include-dag --format=json ``` 1. 特定のレコードの詳細情報を表示します 2. 特定のレコードの詳細情報をJSON形式で表示します 3. 接続用認証情報や管理用認証情報など、KeeperPAMに関する情報を含むJSON出力を生成します。 {% hint style="info" %} 出力としてパスワードのみを取得する方法については、`clipboard-copyコマンドをご参照ください。` {% endhint %} ### **record-historyコマンド** <a href="#record-history-command" id="record-history-command"></a> **コマンド:** `record-history`または`rh` **詳細:** レコードのUIDを指定して、レコードの変更履歴を表示します **パラメータ:** レコードのUID **スイッチ:** -a、--action <{*list, diff, show, restore}*> レコードに対する操作を実行します * list - リビジョンを表示します * diff - 各リビジョンで行われた変更を表示します * show - 現在のリビジョンの詳細を表示します * restore - 以前のリビジョンに復元します（`-r`または`--revision`引数が必要です） -r、--revision <リビジョン番号> 特定のリビジョンの詳細のみを表示します **例:** ``` record-history rvwIBG_ban2VTH64OsnzLn record-history rvwIBG_ban2VTH64OsnzLn -a diff record-history rvwIBG_ban2VTH64OsnzLn -r 4 record-history rvwIBG_ban2VTH64OsnzLn -a restore -r 2 ``` 1. 特定のレコードの変更履歴一覧 2. 特定のレコードの各バージョンで加えられた変更一覧 3. 特定のレコードの4番目のリビジョンの詳細 (V.4) 4. 指定したレコードを2番目のバージョンに復元します ### **totpコマンド** <a href="#totp-command" id="totp-command"></a> **コマンド:** `totp` **詳細:** パスまたはUIDを指定して、レコードの二要素コードを表示します。 パスもUIDも指定されていない場合は、二要素コードを含むレコードのリストを表示します **パラメータ:** レコードのパスまたはUID (オプション) **スイッチ:** `--details` 2FAの詳細情報を表示します `--range <RANGE>` 最後のコードと次の\[x]件のコードを表示します `--format <{table, json}>` 出力形式を選択します。 * table – 結果を表形式で表示 (デフォルト) * json – 結果をJSON形式で表示 **例:** ``` totp totp Dropbox totp U-QSpjIL9e9_huXrbTwz4Q totp Dropbox --range 1 totp U-QSpjIL9e9_huXrbTwz4Q --details totp U-QSpjIL9e9_huXrbTwz4Q --format json ``` 1. TOTP二要素コードを含むレコードのリスト 2. 「Dropbox」レコードのタイマー付き二要素コードを表示します 3. 指定したUIDを持つレコードのタイマー付き二要素コードを表示します 4. 「Dropbox」レコードの最後、現在、次の二要素コードを表示します 5. 指定したUIDを持つレコードのTOTPトークンの詳細情報を表示します 6. 指定したUIDのレコードに対応するTOTPトークンの詳細をJSON形式で表示します。 ### **download-attachmentコマンド** <a href="#download-attachment-command" id="download-attachment-command"></a> **コマンド:** `download-attachment` **詳細:** レコードのパスまたはUIDを指定して、指定したレコードに添付されたファイルをすべてダウンロードします **パラメータ:** レコードまたはフォルダのパスまたはUID **スイッチ:** `-r`または`--recursive` サブフォルダをたどって再帰的にダウンロードします `--out-dir <LOCAL DIRECTORY>` ダウンロードされたファイルのローカルフォルダ `--preserve-dir` ボルトのフォルダ構造を維持します `--record-title` ダウンロードした添付ファイルのタイトルにレコード名を追加します **ダウンロードした添付ファイルの命名規則** <table><thead><tr><th width="237.4545454545455">命名規則</th><th>説明</th></tr></thead><tbody><tr><td><code>$AttachmentFileName</code></td><td>デフォルトでは、ダウンロードされた添付ファイルはすべて元の名前を保持します。<br><br>レコードに添付ファイル「file.txt」が含まれている場合、ダウンロードされた添付ファイルの名前は、<code>file.txt</code>になります。</td></tr><tr><td><code>$AttachmentFileName($RecordUUID).$AttachmentFileNameExtension</code></td><td>これは重複がある場合の命名規則です。<br><br>レコードに同じ名前 (「file.txt」) の添付ファイルが2つ含まれている場合、または出力ディレクトリに同じ名前のファイルがすでにある場合、ダウンロードされた添付ファイルの命名規則は次のようになります。<br><code>file.txt</code>と<code>file(Lw7K5ah3LjP5uVkhkrSzrw).txt</code></td></tr><tr><td><code>$AttachmentFileName($AttachmentUUID).$AttachmentFileNameExtension</code></td><td>重複したため、上の行の命名規則が使用された場合、<code>RecordUUID</code>ではなく<code>AttachmentUUID</code>が使用されます。<br><br>上記の行の想定例では、file.txtをダウンロードすると、<code>recordUUID</code>ではなく、次のように<code>attachmentUUID</code>が使用されます。<br><code>file(Bu2WLg-7eqWPhO-NW18lgw).txt</code></td></tr><tr><td><code>$RecordName-$AttachmentFileName</code></td><td><code>--record-title</code>スイッチを付けると、ダウンロードした添付ファイルにレコード名が追加されます。これは重複にも適用されます。<br><br>「Record 1」という名前のレコードに添付ファイル「file.txt」が含まれる場合、この命名規則では次のようになります。<br><code>Record1-file.txt</code></td></tr></tbody></table> **例:** ``` download-attachment "documents/Financial Records" download-attachment _j0SPqnUeUCZN5UoEfD6cg download-attachment / --recursive --preserve-dir --out-dir=C:\\Attachments download-attachment "documents/Financial Records" --record-title ``` 1. 「documents」フォルダの「Financial Records」というタイトルのレコードのすべての添付ファイルをダウンロードします 2. 指定したUIDを持つレコードのすべての添付ファイルをダウンロードします 3. ボルト内のすべての添付ファイルを、指定した次の出力場所に再帰的にダウンロードします。「C:\Attachments」 4. 「documents」フォルダの「Financial Records」というタイトルのレコードのダウンロード可能なすべての添付ファイルの名前に「Financial Records」というレコード名を追加します ### **upload-attachmentコマンド** <a href="#upload-attachment-command" id="upload-attachment-command"></a> **コマンド:** `upload-attachment` **詳細:** ファイルをアップロードし、特定のレコードのパスまたはUIDを指定してそのレコードに添付します **パラメータ:** レコードのパスまたはUID **スイッチ:** `--file <FILENAME>` アップロードするファイル名 (必須) **例:** ``` upload-attachment "documents/Financial Records" --file C:/June_2021.pdf upload-attachment _j0SPqnUeUCZN5UoEfD6cg --file C:/Users/pictures/5_15_21.jpeg ``` 1. 「documents」フォルダの「Financial Records」レコードにpdfファイルを添付します 2. 指定したUIDを持つレコードに画像を添付します ### **delete-attachmentコマンド** <a href="#delete-attachmant-command" id="delete-attachmant-command"></a> **コマンド:** `delete-attachment` **詳細:** 特定のレコードのパスまたはUIDを指定して、そのレコードに添付されたファイルを削除します **パラメータ:** レコードのパスまたはUID **スイッチ:** `--name <FILE>` 削除するファイルの名前またはID (必須) **例:** ``` delete-attachment "documents/Financial Records" --name June_2021.pdf delete-attachment _j0SPqnUeUCZN5UoEfD6cg --name 5_15_21.jpeg delete-attachment -o ``` 1. 「documents」フォルダの「Financial Records」レコードから「June\_2021.pdf」という名前のpdfファイルを削除します 2. 指定したUIDを持つレコードから「5\_15\_\_\_21.jpg」という名前の画像を削除します 3. ボルト内の孤立したファイル添付をすべてを削除します ### **file-reportコマンド** <a href="#file-report-command" id="file-report-command"></a> **コマンド:** `file-report` **詳細:** ボルト内でアクセスできるすべてのファイルの詳細レポートを表示します。レポートはタイトル、レコードUID、ファイルIDで構成されます。 **スイッチ:** `-d`、`--try-download` ボルト内のすべての添付ファイルのダウンロードを試みます **例:** ``` file-report file-report -d ``` 1. ボルト内のレコードに添付されたすべてのファイルのレポートを表示します 2. ボルト内のレコードに添付されたすべてのファイルのダウンロードを試みます ### **list-sfコマンド** <a href="#list-sf-command" id="list-sf-command"></a> **コマンド:** `list-sf`または`lsf` **詳細:** ボルト内のすべての共有フォルダのUID、名前、デフォルト権限、レコード権限、ユーザー権限、チーム権限を表示します **例:** ``` lsf ``` 1. ボルト内のすべての共有フォルダの詳細情報を表示します ### **list-teamコマンド** <a href="#list-team-command" id="list-team-command"></a> **コマンド:** `list-team`または`lt` **詳細:** アクセスできるチームそれぞれのUIDと名前を表示します **スイッチ:** * `-v`、 `--verbose`\ 各チーム内のユーザーを一覧表示します。 * `-a`、 `--all`\ 連絡先リスト内のすべてのチームを表示します。これには、MSP管理者が管理する企業など、所属組織外のチームも含まれます。 **例:** ``` list-team list-team -v list-team -a ``` 1. アクセス可能なすべてのチームの詳細情報を表示します 2. 各チームに属するメンバーの一覧を表示します。 3. 自分がアクセス可能なすべてのチームを一覧表示します。他の組織に属するチーム (例: MSP管理者として管理している企業のチームなど) も含まれます。 ### record-addおよびrecord-updateコマンド <a href="#record-add-and-record-update-commands" id="record-add-and-record-update-commands"></a> **コマンド**: `record-add`または`record-update` **詳細**: ボルトにレコードを追加するか、既存のレコードを更新します。レコードを追加および更新する場合に推奨されるコマンドです。すべてのレコードタイプ、カスタムタイプ、標準フィールド、カスタムフィールドがサポートされています。詳細な例については、`--syntax-help`をご参照ください。 **パラメータ**: スペースで区切られたフィールド値のリスト。フィールドの構文は次のとおりです。 `<FIELD_NAME>=<FIELD_VALUE> see ...` **スイッチ**: `-t`、`--title` レコードタイトル `-n`、`--notes` レコードメモ `-rt、--record-type` レコードタイプ。標準レコードタイプの一覧を表示します。 `-f`、`--folder` `<FOLDER PATH or UID>` レコードのフォルダ。`record-add`にのみ適用されます。 `--self-destruct <数字> [ (mi)分| (h)時間| (d)日| (mo)月| (y)年]` レコード共有用URLの有効期間を指定します。レコードは開かれてから5分後にボルトから削除されます。このオプションは`record-add`コマンドにのみ適用されます。 `-r`、`--record` `<RECORD PATH or UID>` 編集するレコードのパスまたはUID。`record-update`にのみ適用されます。 `-f`、`--force` 警告を無視します。 `--syntax-help` これらのコマンドの使用方法に関する詳細情報を表示します。 `--email-config <NAME>` 送信に使用するメール構成を指定します (`--send-email` と併用時は必須) `--send-email <EMAIL>` ワンタイム共有リンクをメールで送信します `--email-message <MESSAGE>` カスタムメール本文を指定します (任意) **例**: {% code overflow="wrap" lineNumbers="true" %} ``` record-add --title="Sample Login" --record-type=login --folder="Personal Folder" login=username password=$GEN url=https://www.google.com "License ID"="9ACB123" url.AlternateURL=https://amazon.com record-add --title="Empty Legacy Record" --record-type=legacy record-add --syntax-help record-update --syntax-help record-add -t "Temporary Shared Login (1 hr)" -rt login --self-destruct 1h record-add --record-type login --title 'Demo User - Gmail' login=demo.user@company.com password=$GEN --self-destruct 1h --email-config 'Demo-Gmail' --send-email 'demo@example.com' ``` {% endcode %} record-addコマンドを使用してレコードを作成する際の詳細な例については、[こちらのページ](https://docs.keeper.io/jp/keeperpam/commander-cli/command-reference/record-commands/creating-and-updating-records)をご参照ください。 ワンタイム共有リンクをメールで送信するには、メールプロバイダーの設定が必要です。 ### **rmコマンド** <a href="#rm-command" id="rm-command"></a> **コマンド:** `rm` **詳細:** 指定したパスまたはUIDを持つレコードを削除します **パラメータ:** レコードのパスまたはUID **スイッチ:** `-f`、`--force` プロンプトを表示しません **例:** ``` rm social/Twitter rm -wAZ13kI8d326j1HEUTqmQ -f rm rec1 rec2 ``` 1. 「social」フォルダの「Twitter」レコードを削除します。「y」を入力して承認するよう促すプロンプトが表示されます。 2. 指定したUIDを持つレコードを削除し、承認のプロンプトを表示しません。 3. レコード「rec1」と「rec2」を削除します ### delete-all コマンド **コマンド:** `delete-all`\ **概要:** ユーザーボルトからすべてのレコードとフォルダを削除します。 #### スイッチ * `-f`, `--force` – 確認プロンプトを表示せずに強制的に削除 #### 重要な注意事項 * 共有フォルダおよびそのレコードは自動的にスキップされます。 * ユーザーフォルダおよびレコードのみが対象です。 * レコードは1回のAPI呼び出しにつき最大999件ずつ削除されます。 * フォルダは1回のAPI呼び出しにつき最大500件ずつ削除されます。 * この操作は**元に戻すことができません**。 #### 共有フォルダの扱い 共有フォルダの場合は、以下の手順で削除を行うことを推奨します。 1. `transform-folder <shared_folder_uid>` を実行して共有フォルダをユーザーフォルダに変換 2. その後、`delete-all` を実行して残りのボルト内容を削除 このコマンドは、スキップされた共有フォルダの内容について警告を表示します。 #### 使用例 **基本的な使い方** ``` delete-all ``` ボルト内のすべてのレコードとフォルダを削除します。実行前に警告メッセージと確認プロンプトが表示されます。 **確認なしで強制削除** ``` delete-all -f ``` または ``` delete-all --force ``` 確認を求めずに、ボルト内のすべてのレコードとフォルダを削除します。 #### 注意点 * このコマンドは**すべてのレコードおよびフォルダを削除**します。 * 使用前に必ずバックアップを取得してください。 * 安全のため、共有フォルダおよびそのレコードは自動的にスキップされます。 ### **append-notesコマンド** **コマンド:** `append-notes`または`an` **詳細:** 指定したパスまたはUIDを持つレコードのメモに追加します **パラメータ:** レコードのパスまたはUID **スイッチ:** `--notes <NOTES>` 追加するメモ **例:** ``` append-notes social/Twitter an KEdxyHgtCOv3hBdjz_aJEw --notes "Outdated as of June 2021" ``` 1. 「social」フォルダの「Twitter」レコードのメモに追加します。追加するメモの入力を促すプロンプトが表示されます 2. 指定したUIDを持つレコードのメモに「2021年6月時点で期限切れ」というメッセージを追加します ### **mkdirコマンド** <a href="#mkdir-command" id="mkdir-command"></a> **コマンド:** `mkdir` **詳細:** 指定したパスにフォルダまたは共有フォルダを作成します **パラメータ:** 新しいフォルダのパス/名前 **スイッチ:** `-sf`、`--shared-folder` 共有フォルダを作成します `-uf`、`--user-folder` ユーザーフォルダを作成します (共有しない) `-a`、`--all` すべてのユーザーにユーザー管理、レコード管理、レコード共有、レコード編集を許可するデフォルトのフォルダ権限を設定します `-u`、`--manage-users` すべてのユーザーにユーザーアクセス管理を許可するデフォルトのフォルダ権限を設定します `-r`、`--manage-records` すべてのユーザーにレコード管理を許可するデフォルトのフォルダ権限を設定します `-s`、`--can-share` すべてのユーザーにレコード共有を許可するデフォルトのフォルダ権限を設定します `-e`、`--can-edit` すべてのユーザーにレコード編集を許可するデフォルトのフォルダ権限を設定します `--color <`*`{none, red, green, blue, orange, yellow, gray}`*`>` フォルダの色を設定します {% hint style="info" %} 共有フォルダに他のユーザーまたはチームを追加する場合、共有時にアクセス権限が特に取り消されたり追加されたりしない限り、そのフォルダのデフォルトのアクセス権限が付与されます。 詳細については、[share-folder](https://docs.keeper.io/jp/keeperpam/commander-cli/sharing-commands#share-folder-command)コマンドをご参照ください。 {% endhint %} **例:** ``` mkdir finance/personal mkdir social -uf mkdir office-codes -sf -s ``` 1. 既存の「finance」フォルダに「personal」という名前のフォルダを作成します。共有フォルダまたはユーザーフォルダの作成を促すプロンプトが表示されます 2. 「social」という名前のユーザーフォルダを作成します 3. すべてのユーザーがフォルダ内のレコードを共有できるように、デフォルトのアクセス権限を設定した「office-codes」という名前の共有フォルダを作成します ### **rmdirコマンド** <a href="#rmdir-command" id="rmdir-command"></a> **コマンド:** `rmdir` **詳細:** フォルダのパスまたはUIDを指定してフォルダまたは共有フォルダを削除します **パラメータ:** フォルダのパス パターンを判定し、一致するフォルダをすべて削除します。 * `*` すべてに一致 * `?` 任意の単一の文字に一致 * `[seq]` \_配列\_内の任意の文字に一致 * `[!seq]` \_配列\_に含まれない任意の文字に一致 スペースで区切られた複数のパラメータを指定できます **スイッチ:** `-f`、`--force` プロンプトを表示せずにフォルダを削除します `-q`、`--quiet` `-f`と一緒に使用した場合、出力を返しません **例:** ``` rmdir social/temporary rmdir zXuYXRYWgsie5TBPzQACLw -f rmdir [A-Z]*2 rmdir DevOps/secrets MyFolder rmdir t5uYXRYWgsie5TBPzQACLw -f -q rmdir * ``` 1. 「social」フォルダの「temporary」という名前のフォルダを削除します。 確認を求めるプロンプトが表示されます 2. 指定したUIDを持つフォルダを削除し、確認を求めるプロンプトを表示しません 3. 名前に文字だけを使用し、最後が「2」のフォルダをすべて削除します 4. 「DevOps」フォルダの「secrets」フォルダと「MyFolder」フォルダを削除します 5. 指定したUIDを持つフォルダを削除し、出力は一切表示しません 6. Keeperボルトからすべてのフォルダを削除します ### **rndirコマンド** <a href="#rndir-command" id="rndir-command"></a> **コマンド**: `rndir` **詳細**: フォルダまたは共有フォルダのパスまたはUIDを指定して名前を変更します。 **パラメータ**: フォルダのパス **スイッチ**: * `-n`、 `--name <新しいフォルダ名>` 新しいフォルダ名を指定 * `--color {none,red,green,blue,orange,yellow,gray}` フォルダの色を設定または変更 * `-q`、`--quiet` 出力を表示しません **例:** ``` rndir --name="Dev Ops/secrets" --color=red zXuYXRYWgsie5TBPzQACLw ``` ### **mvコマンド** <a href="#mv-command" id="mv-command"></a> **コマンド:** `mv` **詳細:** レコードまたはフォルダのパスもしくはUID、および移動先フォルダのパスもしくはUIDを指定して、レコードまたはフォルダを別のフォルダに移動します **パラメータ:** レコードのパスもしくはUIDの後に移動先フォルダのパスもしくはUID **形式:** `mv SRC DST` SRC: フォルダまたはレコードへのソースパス。 タイトルパス、検索パターン、UIDを指定できます DST: 移動先のフォルダ名またはUID **スイッチ:** `-f`、`--force` プロンプトを表示せずにレコードまたはフォルダを移動します `-s`、`--can-reshare` すべてのユーザーがレコードを再共有できます `-e`、`--can-edit` すべてのユーザーがレコードを編集できます **例:** ``` mv Twitter social mv zXuYXRYWgsie5TBPzQACLw / ``` 1. 「Twitter」レコードを「social」フォルダに移動します 2. 指定したUIDを持つレコードをルートフォルダに移動します ### **lnコマンド** <a href="#ln-command" id="ln-command"></a> **コマンド:** `ln` **詳細:** レコードまたはフォルダのパスもしくはUID、および宛先フォルダのパスもしくはUIDを指定して、レコードまたはフォルダを別のフォルダにリンクします **パラメータ:** レコードのパスもしくはUIDの後に移動先フォルダのパスもしくはUID **形式:** `ln SRC DST` SRC: フォルダまたはレコードへのソースパス。 タイトルパス、検索パターン、UIDを指定できます DST: リンク先のフォルダ名またはUID **スイッチ:** `-f`、`--force` プロンプトを表示せずにレコードまたはフォルダを移動します `-s`、`--can-reshare` すべてのユーザーがレコードを再共有できます `-e`、`--can-edit` すべてのユーザーがレコードを編集できます **例:** ``` ln Twitter social ln zXuYXRYWgsie5TBPzQACLw / ``` 1. 「Twitter」レコードを「social」フォルダにリンクします 2. 指定したUIDを持つレコードをルートフォルダにリンクします ### **find-duplicateコマンド** <a href="#find-duplicate-command" id="find-duplicate-command"></a> **コマンド:** `find-duplicate` **詳細:** 1つまたは複数のレコードフィールドに基づいてボルト内の重複レコードを検索するのに便利なツール。 **パラメータ:** 比較に使用するフィールドのリストを指定します。 **スイッチ:** `--title` タイトルフィールドを照合して重複を検索します `--login` ログインフィールドを照合して重複を検索します `--password` パスワードフィールドを照合して重複を検索します `--url` URLフィールドを照合して重複を検索します `--shares` 共有権限で照合します `--full` すべてのフィールドを照合して重複を検索します `--merge、-m` 重複レコードを統合します (このフラグを付けると、重複レコードは共有を含むすべてのフィールドで自動的に照合されます) `--ignore-shares-on-merge` 重複レコードをマージするために照合する際に共有権限を無視します `--force、-f` 確認を求めるプロンプトを表示せずに重複を削除します (--mergeオプションを指定した場合のみ有効) `--quiet、-q` 画面出力を抑制します (`--force/--merge`オプションを指定した場合のみ有効) `--dry-run、-n` 重複の削除をシミュレーションします (レコードは削除も変更もされません)。`--merge`フラグを指定した場合のみ有効 `--scope,` `-s <enterprise, vault>` 検索の範囲を定義します (デフォルトはボルト)。 enterpriseスコープは、コンプライアンスデータアクセス権限を持つエンタープライズアカウント管理者のみが使用できます。 `--refresh-data`, `-r` ローカルキャッシュに最新の監査データを格納します。 `--scope=enterprise`オプションと一緒に使用した場合にのみ有効です。 `--format` `<{csv, json, table}>` 出力形式を選択します `--output <ファイル名>` 検索結果をファイルに出力します **例:** ``` find-duplicate --title find-duplicate --login --password find-duplicate --login --password --url find-duplicate --full find-duplicate --merge --force find-duplicate --merge -n find-duplicate -s enterprise --format csv --output enterprise_duplicates.csv ``` 1. 一致するタイトルに基づいて重複レコードを検索します 2. 一致するログインとパスワードに基づいて重複レコードを検索します 3. 一致するログイン、パスワード、ウェブサイトアドレスに基づいて重複レコードを検索します 4. すべての関連フィールド (各レコードに適用されるカスタムフィールドと共有アクセス権限を含む) を照合して重複レコードを検索します 5. すべての関連フィールド (および共有) で一致する重複レコードを検索し、レコードを削除する前に確認プロンプトを表示せずに、重複レコードのセットごとに1つのレコードに統合します (つまり、互いに重複しているとみなされるレコードのセットごとに、1つのレコードを除いてすべて削除します) 6. 重複レコード (すべてのフィールドで一致するもの) を検索し、結果の統合をシミュレーションします 7. 企業全体のボルトに渡って重複したレコードを検索し、検索結果を**enterprise\_duplicates.csv**というCSV形式のファイルに出力します ### **shortcutコマンド** <a href="#shortcut-command" id="shortcut-command"></a> **コマンド:** `shortcut` **詳細:** レコードのショートカットを一覧表示または管理します。 ショートカットは、レコードが属するフォルダ以外のフォルダ内にあるレコードへのリンクです。 **パラメータ:** コマンド: * list <レコードUID, フォルダUID, パス (オプション)>: すべてのショートカットの一覧を表示します。レコードやフォルダを指定した場合はフィルタリングします * keep <レコードまたはファイルパス> : 1つのショートカットを除くすべてのショートカットを削除します **スイッチ:** listのスイッチ: `--format <{`*`csv, json, table}`*`>` 出力形式を選択します `--output <FILENAME>` 出力結果を書き込むファイル **例:** ``` shortcut list shortcut list --format csv --output "shortcuts.csv" shortcut list 461XtX26R1SggIyQDf4HZg shortcut keep "memberships/My Membership" ``` 1. レコードのショートカットの一覧を表示します 2. レコードのショートカットの一覧をファイルに出力します 3. 指定したUIDを持つフォルダ内に存在するレコードのショートカットの一覧を出力します 4. 指定した場所にあるレコード以外のすべてのレコードのショートカットを削除します **使用例:`keep`コマンドを使用して1つを除くすべてのショートカットを削除します** 以下のレコードに複数のショートカットがあり、そのレコードを保持したいだけとします ``` My Vault> shortcut list 461XtX26R1SggIyQDf4HZg Record UID Record Title Folder ---------------------- -------------- ---------------------- 461XtX26R1SggIyQDf4HZg ksm-key1 [ User ] /key-folder1/ [ User ] /key-folder2/ [ User ] /key-folder3/ ``` このレコードを「key-folder2」にのみ保持し、他のすべてのショートカットを削除するには、次のコマンドを実行します。 ``` My Vault> shortcut keep 461XtX26R1SggIyQDf4HZg key-folder2 ``` {% hint style="info" %} 上記のコマンドを実行すると、余分なショートカットの削除の確認を求めるプロンプトが表示されます {% endhint %} 余分なショートカットが削除されたことを確認するには、次のいずれかの手順を実行してください。 1. ウェブボルトにアクセスし、ショートカットが削除されていることを確認します。\ 例:\ 上記のシナリオと例では、`key-folder2`にレコード`ksm-key1`のインスタンスが1つだけ表示されます 2. `shortcut list <Record UID>`コマンドを実行すると、そのレコードにはショートカットがないと出力されます\ 上記のシナリオと例では、不要なショートカットを削除した後、`list`コマンドを実行すると以下のように表示されます。 ``` My Vault> shortcut list 461XtX26R1SggIyQDf4HZg shortcut-get:Record UID 461XtX26R1SggIyQDf4HZg does not have shortcuts ``` ### **transform-folderコマンド** <a href="#transform-folder-command" id="transform-folder-command"></a> コマンド: `transform-folder` **詳細:** フォルダを共有フォルダから個人用フォルダに変換します (またはその逆) **パラメータ:** フォルダUIDまたはパス/名前 (複数の値を指定できます) **スイッチ:** `-l、--link` ソースフォルダを削除しません。レコードを移動する代わりにレコードリンクを作成します `-n`、`--dry-run` 更新せずにフォルダ変換をプレビューします `-f`、`--force` 確認プロンプトを省略して出力を最小化します `-t, --target=TARGET` 対象フォルダのUIDまたはパス/名前を指定します (省略時はルートフォルダ) `--folder-type {personal,shared}` `--target`が省略された場合、新しいフォルダの種類を指定します **例:** ``` My Vault> transform-folder --link SharedFolder1/FolderToTransform The following folder(s) will be copied to "My Vault" Source Folder Folder Count Record Count --------------- -------------- -------------- SharedFolder1/Database/ 123 1234 Are you sure you want to proceed with this action? [y/n]: y Executing transformation(s)... ``` 1. **ユーザーフォルダを** **共有フォルダに変換します** ボルトのルートフォルダ内から次のコマンドを実行します ``` My Vault> transform-folder "My Folder (Misc.)" ``` 「My Folder (Misc.)」がユーザーフォルダである場合、共有フォルダに変換されます。`transform-folder`コマンドは、パラメータが指定されていない場合をユーザーフォルダを共有フォルダに、または共有フォルダをユーザーフォルダにに変換します。 2. **共有フォルダをユーザーフォルダに変換します** ボルトのルートフォルダ内から次のコマンドを実行します ``` My Vault> transform-folder "Shared Folder (Team3, Admin)" ``` {% hint style="warning" %} セキュリティ上の理由と、特定の共有フォルダに格納できるフォルダの種類に現在制限があるため、指定したボルト内のすべてのフォルダが上記のコマンドを使用して変換できるとは限りません。そのため、ある種のフォルダはこのコマンドを実行できません。具体的には、以下のフォルダが含まれます。 1. フォルダ自体、いずれかのサブフォルダ、またはいずれかのサブフォルダのサブフォルダなどに、以下の項目のいずれか1つを含むユーザーフォルダ * 次のいずれの権限も持っていないユーザーの共有フォルダ 1. 共有管理者権限 2. 完全共有権限 (「共有先の管理」、「レコードの追加と削除を許可」) * 次のいずれの権限も持っていないユーザーの直接共有レコード 1. 共有管理者権限 2. 再共有権限 (「共有可」) 2. 共有フォルダに含まれるユーザーフォルダ (つまり、親フォルダまたは親フォルダの親フォルダなどが共有フォルダであるユーザーフォルダ) {% endhint %} ### **trashコマンド** <a href="#trash-command" id="trash-command"></a> **コマンド:** `trash <sub command>` **詳細:** ごみ箱の削除されたレコードを一覧表示または管理します。 削除されたレコードは、ゴミ箱を空にするまでゴミ箱に残ります。 **パラメータ:** サブコマンド: * `list <SEARCH PATTERN>` :ゴミ箱内のすべての削除済みレコードの一覧を表示します。レコードやフォルダを指定した場合はフィルタリングします * `get <RECORD UID>` : 指定したUIDを持つ削除されたレコードに関する情報を表示します * `restore <RECORD UID(S)>` : 以前に削除したレコードを復元します。スペースで区切られた複数のUIDを指定できます * `unshare <RECORD UID(S)>:` 削除されたレコードの共有を削除します * `purge` : ゴミ箱のすべてのレコードを完全に削除します **スイッチ:** listのスイッチ: `--format <{`*`csv, json, table}`*`>` 出力形式を選択します `--output <FILENAME>` 出力結果を書き込むファイル `--reload` 削除されたレコードの一覧を更新します **listの例:** ``` trash list trash list --format csv --output "deleted.csv" trash list Twitter* ``` 1. 削除されたレコードの一覧を表示します 2. 削除されたレコードの一覧を「deleted.csv」という名前のファイルに出力します 3. タイトルが「Twitter」で始まる削除済みレコードの一覧を表示します **getの例:** ``` trash get Do5[...]mJw ``` 1. 指定したUIDを持つ削除されたレコードの詳細情報を表示します restoreスイッチ: `--force` 復元時にプロンプトを表示しません **listの例:** ``` trash restore DoO[...]Gw trash restore DoO[...]Gw Gng[...]1-g trash restore --force DoO[...]Gw Gng[...]1-g ``` 1. 指定したUIDを持つ削除されたレコードを復元します 2. 指定したUIDを持つすべての削除されたレコードを復元します 3. 指定したUIDを持つすべての削除されたレコードをプロンプトを表示せずに復元します **unshareの例**: ```shell // すべての削除レコードから共有を削除します trash unshare * // 単一のレコードから共有を削除します trash unshare <RECORD UID> ``` **purgeの例:** ``` trash purge ``` 1. 削除されたすべてのレコードをゴミ箱からも削除します ### password-reportコマンド <a href="#password-report-command" id="password-report-command"></a> **コマンド:** `password-report` **詳細:** パスワードレポートを表示する **スイッチ:** `--policy <comma separated integers>` パスワードの複雑さに関するポリシー。長さ,小文字,大文字,数字,特殊文字 例: 12,2,2,2,0 `--length <Number>` 最短のパスワードの長さ `--lower <Number>` 最小の小文字の数 `--upper <Number>` 最小の大文字の数 `--digits <Number>` 最小の数字の数 `--special <Number>` 最小の特殊文字の数 **パラメータ:** `folder` 任意。フォルダ内の弱いパスワードをスキャンします。 **例:** <pre><code>My Vault> password-report --policy=12,2,2,2,0 <strong>My Vault> password-report --length=10 --digits=2 </strong></code></pre> ### find-ownerlessコマンド <a href="#find-ownerless-command" id="find-ownerless-command"></a> **コマンド:** find-ownerless **詳細:** 所有者のいないボルト内のレコードをリストします (任意で所有権を取得します)。 **スイッチ:** `--format <{`*`csv, json, table}`*`>` 出力形式を選択します `--output <ファイル名>` 出力結果を含めるファイル (table形式の場合は無視されます) `--claim` 見つかったレコードの所有権を取得します `-v, --verbose` 見つかった各レコードの詳細を出力します **パラメータ:** `folder` 検索するフォルダのパスまたはUID（任意で複数の値も可能） **例:** <pre><code>My Vault> find-ownerless -v <strong>My Vault> find-ownerless --claim </strong></code></pre> 1. 所有者のいないすべてのレコードを検索し、見つかった各レコードの詳細を出力します 2. 見つかった所有者のいないレコードを全て取得します