レコードコマンド
レコード関連コマンドの説明
概要
本セクションでは、Keeperコマンダー (CLI) でボルト内のレコードを操作するコマンドを列挙します。この文脈での「レコードコマンド」は、レコードの追加・編集・取得などを指します。レコードや関連する添付ファイルの作成・参照・編集・整理・管理を扱います。
現在、次のコマンドをSDKで利用できます。
レコード専用コマンドに加え、SDKではレコード添付の機能も利用できます。詳細はこちらをご参照ください。次を含みます。
レコード追加コマンド
このコマンドはKeeperボルトに従来型レコードを追加するために使います。すべてのレコードタイプ、カスタムタイプ、標準フィールド、カスタムフィールドを指定できます。階層型共有サブフォルダ (NSF) のレコードを追加する場合は、階層型共有サブフォルダのレコード追加コマンドをご利用ください。
DotNet CLI
コマンド : add-record
パラメータ:
-t, --type
レコードタイプ (login、bankAccount、address など)
--title
レコードのタイトル
オプション:
--folder
レコードを作成するフォルダー名またはUID
-g, --generate
ランダムパスワードを生成する
--self-destruct
一定時間後に自動削除 (5m、2h、1d など)
レコードフィールド:
fieldname=value 形式でフィールドを追加する。
例:
DotNet SDK
メソッド:
引数:
record
KeeperRecord
はい
レコード情報を含むKeeperRecord型のデータ
folderUid
string
いいえ
レコードを作成するフォルダーのUID (既定: null = ルートフォルダー)
戻り値:
Task<KeeperRecord> — 付与されたUIDを持つ作成済みKeeperRecordを返すタスク
使用例: こちらをご参照ください
PowerCommander
コマンド : Add-KeeperRecord
別名: kadd
パラメータ:
-RecordType
レコードタイプを指定する (既定: login)
-Title
レコードのタイトル
フラグ:
-Folder
レコードを作成するフォルダーのUID
-GeneratePassword
ランダムパスワードを生成する。単独指定時は既定ルール (Length=20、Upper=4、Lower=4、Digit=2、Special=2) を使用する。
-PasswordRules
カスタム生成ルール: Length、Upper、Lower、Digit、Special。
例: -PasswordRules 20,5,5,5,5
値は5つ必須: Length、Upper、Lower、Digit、Special。
-SpecialChars
生成パスワードに記号を含める。
形式: Charset (charsetは任意)
例: -SpecialChars "!@#$"。
既定のcharsetは !@#$%()+;<>=?[]{}^.,
-Notes
レコードにメモを追加する
-SelfDestruct
共有レコードURLの有効期限 (形式: m、h、d。最大: 180日/6ヶ月)。閲覧から5分後にレコードが消える
-GeneratePassphrase
ランダムなパスフレーズを生成し、password フィールドに保存。-GeneratePassword とは同時指定不可。
単独指定時の既定値: 5語、"-" 区切り、useCaps=true、useDigits=true
-PassphraseRuleValues
パスフレーズのオプション設定 (指定時はパスフレーズも生成): WordCount, Separator, UseCaps, UseDigits。
例: -GeneratePassphrase -PassphraseRuleValues 5,-,true,true (WordCount: 5〜9。区切り: - . _ ! ? またはスペース)
例:
使用例のサンプルはこちらをご参照ください
Python CLI
コマンド: record-add
パラメータ:
-t --title レコードのタイトル (必須)
-n --notes レコードのメモ
-rt --record-type レコードタイプ (必須)
--folder レコードを追加するフォルダー
--self-destruct 共有レコードURLの有効期限。m、h、d のいずれかで指定。最大 180d (6ヶ月)。閲覧から5分後にレコードが消える
-f --force 警告を無視しプロンプトをスキップする
fields <field_type>=<value> フィールドと値の一覧
パスワード生成:
パスワードフィールド (タイプ付きレコードのパスワードフィールドを含む) は、$GEN 値に対応しています。
利用可能なジェネレーター:
password=$GEN:rand,20: ランダムパスワード。既定のアルゴリズムpassword=$GEN:dice,5: Diceware形式のパスワードpassword=$GEN:crypto: 暗号強度の強力なパスワード
パスフレーズジェネレーター:
password=$GEN:passphrase[,word_count][,separator][,capitalize][,number] を使用します。
word_count: 任意。単語数。指定可能な範囲は5〜9separator: 任意。1文字またはスペース。指定可能な値は-、.、_、?、!、spacecapitalize: 任意。trueまたはfalse。各単語の先頭文字を大文字にするnumber: 任意。trueまたはfalse。最初の単語の末尾に0〜9の数字を追加する
エンタープライズポリシー:
パスフレーズの任意パラメータを省略した場合、単語数・区切り文字・大文字化・数字付加の既定値には、エンタープライズのパスフレーズポリシーが使用されます
エンタープライズポリシーで
passphrase-allowが無効になっている場合、生成はランダムパスワードにフォールバックし、警告がログに記録されます
例:
パスフレーズの例:
レコード更新コマンド
このコマンドはKeeperボルトの既存レコードを更新するために使います。
DotNet CLI
コマンド: update-record
パラメータ:
record
更新するレコードのパスまたはUID
オプション:
--title
レコードのタイトルを更新する
-t, --type
レコードタイプ (型付きレコードのみ)
-g, --generate
ランダムパスワードを生成し、既存のパスワードフィールドを更新する (既定: false)
--help
ヘルプ画面を表示する
--version
バージョン情報を表示する
fields
fieldname=value 形式で追加/更新するレコードフィールド
例:
DotNet SDK
メソッド:
引数:
record
KeeperRecord
はい
更新データを含むレコードオブジェクト (有効なUIDが必要)
skipExtra
bool
いいえ
ファイル添付情報の更新をスキップする (既定: true)
戻り値:
Task<KeeperRecord> — 更新後のKeeperRecordを返すタスク
例:
アプローチ2:
複数レコードを一度に更新する場合、まとめて更新できる。
関数:
戻り値:
Task<IList<RecordUpdateStatus>> — 各レコードの更新ステータス一覧を返すタスク
RecordUpdateStatus のプロパティ:
RecordUid
string
レコードのUID
Status
string
更新ステータス: "success" またはエラーメッセージ
Message
string
追加のステータスメッセージまたはエラー詳細
例:
PowerCommander
コマンド: Add-KeeperRecord
別名: kadd
パラメータ:
-Uid: 更新対象レコードのレコードUid
フラグ:
-GeneratePassword
レコード用の新しいパスワードを生成して更新する
-Title
更新後のタイトル
-Notes
レコードのメモを更新する
-Verbose
詳細な操作情報を表示する
-Debug
実行中のデバッグ情報を表示する
-ErrorAction
エラーへの応答方法 (Continue、Stop、SilentlyContinue、Ignore)
-WhatIf
コマンドレットを実際には実行せず、実行時の動作を表示する
-Confirm
実行前に確認プロンプトを表示する
-GeneratePassphrase
ランダムなパスフレーズを生成し、password フィールドに保存。-GeneratePassword とは同時指定不可。
単独指定時の既定値: 5語、"-" 区切り、useCaps=true、useDigits=true
-PassphraseRuleValues
パスフレーズのオプション設定 (指定時はパスフレーズも生成): WordCount, Separator, UseCaps, UseDigits。
例: -GeneratePassphrase -PassphraseRuleValues 5,-,true,true (WordCount: 5〜9。区切り: - . _ ! ? またはスペース)
要件:
このコマンドは現在のフォルダー内のレコードを更新します。先に、対象フォルダーへカレントを移してください。Set-KeeperFolder コマンドで行えます (参考)。
例:
Python CLI
コマンド: record-update
パラメータ:
-t --title レコードタイトルを変更する (必須)
-rt --record-type レコードタイプを変更する (必須)
-n --notes メモを追記/変更する
-r --record 変更対象のUIDまたはパス (必須)
fields <field type>=<value> フィールドと値の一覧
オプション:
-f --force 警告を無視する
パスワード生成:
$GEN は、レガシーレコードとタイプ付きレコードのいずれのパスワードフィールドでも使用できます。
対応アルゴリズム:
password=$GEN:rand,20: ランダムパスワード。既定のアルゴリズムpassword=$GEN:dice,5: Diceware形式のパスワードpassword=$GEN:crypto: 暗号強度の強力なパスワードpassword=$GEN:passphrase[,word_count][,separator][,capitalize][,number]: パスフレーズジェネレーター
パスフレーズパラメータ:
word_count
いいえ
5〜9 語。既定は 5 またはエンタープライズポリシーの値
separator
いいえ
-、.、_、?、!、space のいずれか。既定は -
capitalize
いいえ
true または false。各単語の先頭文字を大文字にする
number
いいえ
true または false。最初の単語の末尾に数字を追加する
例:
レコード削除コマンド
個人用ボルトフォルダーから複数のレコードを削除するために使います。削除したレコードはオーナーのボルトに残り、すべてのインスタンスが削除されるとオーナーのゴミ箱に残ります。
DotNet CLI
コマンド: rm
フラグ:
--help: このヘルプ画面を表示する。--version: バージョン情報を表示する。record title, uid, or pattern: 削除するレコードのUID/タイトル。
例:
レコード検索・一覧コマンド
このコマンドはKeeperボルト内のすべてのレコードを表形式で一覧表示します。各行にレコードUID、タイトル、タイプ、説明、他ユーザーとの共有の有無が含まれます。
DotNet CLI
コマンド: search
パラメータ:
argument 1: 検索で照合するパターン (必須)。
フラグ:
--verbose: すべてのデータを表示する--limit: 表示するレコード数
例:
Power Commander
コマンド: Get-KeeperRecord
別名: kr
オプション:
-Uid - レコードuidで絞り込む。
-Filter - UID、タイトル、タイプ、説明で絞り込む。
Python CLI
コマンド: list
別名:l
オプション:
-t --type 特定タイプのレコードのみ一覧する。繰り返し指定可
-v --verbose 長いタイトルを表示する
--format Table、csv、json
--output 出力先ファイルのパス
search_text 一覧の条件
例:
Python SDK
関数: find_records
例:
注:
criteria: レコードに含まれるテキストrecord_types: 指定タイプのレコードを返すrecord_version: 指定バージョンのレコードを返す
レコード取得コマンド
このコマンドはレコードの取得専用です。DotNetおよびPython SDKのgetはその他コマンドに分類され、レコード・チーム・フォルダー・共有フォルダーを取得します。
DotNet SDK
現在のdotnet CLIでの実装は、与えられたUIDを複数カテゴリから検索する流れに従います。
UIDがレコードにない場合は、共有フォルダー側でUIDを検索します。
共有フォルダーにない場合は、フォルダーを確認します。
Power Commander
コマンド: Get-KeeperRecord
別名: kr
パラメータ:
Uid: 一致するUidのレコードを返す
フラグ:
Filter: レコード内容を指定値と照合し、一致するものを返すRecordType: レコードタイプで絞り込む (例: "login"、"address"、"payment_card")
例:
Python CLI
コマンド: get <UID>
パラメータ:
uid検索するUIDまたはタイトル (-f、-t、-r 使用時は任意)-f,--folder検索するフォルダーUIDまたはタイトル-t,--team検索するチームUIDまたはタイトル-r,--record検索するレコードUIDまたはタイトル
オプション:
--format 対応する表示形式 - json、details、fields、password
--unmask パスワードなど機密データを出力に含める
--legacy 型付きレコードをレガシーとして表示する
例:
Python SDK
関数: load_record
例:
load_recordはレコードの詳細を返します。レコードには次の4種類があります。
PasswordRecord- レガシーまたは一般TypedRecordFileRecordApplicationRecord
これらのクラスはkeepersdk.vault.vault_recordで定義されています。
レコード履歴コマンド
このコマンドは、(既定アクションで) レコードのリビジョンや変更の一覧表示、特定リビジョンの表示、リビジョン間の差分表示、旧リビジョンの復元に使います。ここでのリビジョンは、特定レコードの変更バージョンに相当します。
Power Commander
コマンド: Get-KeeperRecordHistory
パラメータ:
-Format Table、csv、Json
-Output 出力先ファイルのパス。
-a -Action 対応アクション: list、diff、view、restore
-r, -Revision 表示または復元対象のリビジョン
-Record レコードUIDまたはパス (必須)
例:
Python CLI
コマンド: record-history
パラメータ:
--format Table、csv、Json
--output 出力先ファイルのパス ("table" 形式では無視)
-a --action 対応アクション: list、diff、view、restore
-r, --revision 表示または復元対象のリビジョン
record レコードUIDまたはパス (必須)
オプション:
-v,--verbose詳細出力を表示する
例:
クリップボード出力コマンド
このコマンドはレコードからデータ (パスワード、ログイン、TOTP、カスタムフィールド) を取得し、クリップボード、標準出力、環境変数などへ出力します。
このコマンドの別名は find-password です。
DotNet CLI
コマンド: clipboard-copy
別名: cc, find-password
フラグ:
record: データ取得元のレコードパスまたはUID--username: 同名レコードが複数あるときログイン名で一致させる--output: 出力先 - 値:clipboard(既定)、stdout、stdouthidden、variable--name: 出力がvariableのときの変数名--copy-uid: パスワードの代わりにUIDを出力する-l,--login: パスワードの代わりにログイン名を出力する-t,--totp: パスワードの代わりにTOTPコードを出力する--field: 特定のカスタムフィールドを出力する (ネストはfield:property)-r,--revision: 指定したレコードリビジョンを使う
例:
Power Commander
PowerCommanderでは、このコマンドに以下の2つの実装があります。
フィールドとデータをクリップボードへコピー
コマンド : Copy-KeeperToClipboard [-Record] [-Field] [-Output] [-Username] [-Login] [-Totp] [-CopyUid] [-Name] [-Revision]
パラメータ
Record
レコードUID、タイトル、またはUidプロパティを持つオブジェクト。
Field
コピーするフィールド。Login、Password、URL、Notes、または任意のカスタムフィールド名。
Output
出力先: Clipboard、Stdout、StdoutHidden、Variable。
Username
同一タイトルが複数あるとき、正しいレコードを選ぶためのログイン名。
Login
パスワードの代わりにログインフィールドをコピーする。別名: -l
Totp
パスワードの代わりにTOTPコードをコピーする。別名: -t
CopyUid
パスワードの代わりにレコードUIDをコピーする。
Name
Output が Variable のときの変数名。
Revision
履歴の特定リビジョンを使用する (1 = 1つ前、2 = 2つ前 など)。別名: -r
例
Keeper添付ファイルをストリームへコピー
コマンド: Copy-KeeperFileAttachmentToStream
Keeperレコードから1件のファイル添付をダウンロードします。出力モードは以下の2種類です。
-Path: 添付をファイルへ書き込み。親ディレクトリがなければ自動作成。ディスクへの保存向け-Stream: 添付データを既存のSystem.IO.Streamオブジェクトへ書き込み。メモリ上での処理、パイプ、カスタム処理向け
レコードは レコードUID または レコードタイトル で指定できます。複数の添付がある場合は -Name でファイル名または添付IDを指定します。添付が1件のみの場合は -Name を省略できます。
パラメータ
Record
string
はい
KeeperレコードUIDまたはレコードタイトル
Name
string
いいえ
添付ファイル名または添付ID (添付が1件のみの場合は省略可)
Path
string
はい*
添付の保存先パス (`-Stream` 未使用時は必須。必要に応じてディレクトリを作成)
Stream
System.IO.Stream
はい*
添付データを受け取る書き込み可能なストリーム (`-Path` 未使用時は必須)
-Path と -Stream は同時指定不可。いずれか一方が必須。
例
ファイルへ添付をダウンロード
指定パスへ添付を保存する例。対象ディレクトリが存在しない場合は自動作成されます。
レコードタイトルと添付名で指定する例
添付が1件のみの場合は -Name を省略
ストリームへ添付をダウンロード (メモリ上)
MemoryStream へ添付を書き込み、データを読み取りまたは処理する例
別のリーダー (バイナリなど) でストリームを使う例
Python CLI
コマンド : clipboard-copy
パラメータ:
record レコードパスまたはUID
--username ログイン名で照合 (任意)
--output {clipboard, stdout, stdouthidden, variable} パスワードの出力先
--name 出力が variable の場合の変数名
-cu, --copy-uid パスワードの代わりにUIDを出力
-l, --login ログイン名を出力
-t, --totp TOTPコードを出力
--field カスタムフィールドを出力
-r, --revision 特定のレコードリビジョンを使用
例:
重複レコード検出コマンド
このコマンドは、さまざまな照合条件に基づきボルト内の重複レコードを検索します。重複の表示、または自動マージ/削除が行えます。
DotNet CLI
コマンド: find-duplicates
フラグ:
--title: タイトルで重複を照合する--login: ログインで重複を照合する--password: パスワードで重複を照合する--url: URLで重複を照合する (結果にもURLを表示)--shares: 共有権限で重複を照合する--full: カスタムフィールドを含むすべてのフィールドで照合する-m,--merge: 重複レコードを統合する (各グループで先頭以外を削除)--ignore-shares-on-merge: マージ用のグループ化で共有権限を無視する-f,--force: 確認なしで削除する (--merge指定時のみ有効)-n,--dry-run: 実際には削除せずシミュレーションする (--merge指定時のみ有効)-q,--quiet: 画面出力を抑止する (--force指定時のみ有効)-s,--scope: 検索範囲 - 値:vault(既定)、enterprise-r,--refresh-data: 最新データでローカルキャッシュを更新する (--scope=enterprise指定時のみ有効)
例:
Power Commander
コマンド : Find-KeeperDuplicateRecords [-Title] [-Login] [-Password] [-Url] [-Shares] [-Full] [-Merge] [-Force] [-DryRun] [-Quiet] [-IgnoreSharesOnMerge] [-Scope ] [-RefreshData] [-Format ] [-Output ]
パラメータ
Title
タイトルフィールドで重複を照合する。
Login
ログインフィールドで重複を照合する。
Password
パスワードフィールドで重複を照合する。
Url
URLフィールドで重複を照合する。
Shares
共有権限で重複を照合する。
Full
すべてのフィールド (タイトル、ログイン、パスワード、url、カスタム、共有) で照合する。
Merge
重複を削除する (各グループの先頭レコードを残す)。
Force
確認なしで削除する (-Merge が必要)。
DryRun
削除せずシミュレーションする (-Merge が必要)。
Quiet
出力を抑止する (-Force が必要)。
IgnoreSharesOnMerge
マージ照合で共有権限を無視する。
Scope
検索範囲: vault または enterprise。
RefreshData
キャッシュを更新する (-Scope enterprise が必要)。
Format
出力形式: table、csv、json。
Output
結果をファイルにエクスポートする。
例
Python CLI
コマンド : find-duplicate
パラメータ:
--format {table, csv, json} 出力形式
--output 結果の出力ファイルパス (table 形式では無視)
--title タイトルで重複を照合
--login ログインで重複を照合
--password パスワードで重複を照合
--url URLで重複を照合
--shares 共有権限で重複を照合
--full すべてのフィールドで重複を照合
-m, --merge 重複レコードを統合 (すべてのフィールドと共有を含めて照合)
--ignore-shares-on-merge マージ用のグループ化で共有権限を無視
-f, --force 確認なしで重複を削除 (--merge 指定時のみ有効)
-n, --dry-run 重複削除をシミュレーション (このフラグではレコードは削除・変更されない)。--merge 指定時のみ有効
-q, --quiet 画面出力を抑止 (--force 指定時のみ有効)
-s, --scope {vault, enterprise} 検索範囲 (未指定時は現在のボルトに限定)
-r, --refresh-data 最新のコンプライアンスデータでローカルキャッシュを更新 (--scope=enterprise 指定時のみ有効)
最終更新

