階層型共有サブフォルダコマンド
階層型共有サブフォルダのレコードとフォルダに関するコマンド
コマンド
ロールベースのフォルダ権限を備えた階層型共有サブフォルダの導入に伴い、ボルトのフォルダ、共有、権限モデルを一から再構築し、すべてのユーザーとチームがより柔軟でスケールしやすい体験を得られるようになります。
この移行期間中、新しい階層型共有サブフォルダシステムは既存のクラシックフォルダシステムおよび権限モデルと併存し、2種類のフォルダアイコンでユーザーが容易に区別できるようになっています。
階層型共有サブフォルダはKeeper v3 API上に構築されています。以下のコマンドは、階層型共有サブフォルダ内のフォルダとレコードのみを操作します。nsf- プレフィックスで名前空間化されているため、クラシックボルトのコマンドと明確に区別されます。
対話型シェル、CLI、JSON設定ファイルのいずれを使用する場合でも、以下の階層型共有サブフォルダコマンドが利用可能です。各コマンドでは追加のパラメータとオプションが使えます。
特定のコマンドのヘルプを表示するには、以下を実行します。
help <command>
階層型共有サブフォルダのフォルダとレコードを一覧表示
階層型共有サブフォルダのレコードまたはフォルダの詳細を表示
1件以上のレコードのメタデータ (タイトル、タイプ、バージョン、リビジョン) を表示
階層型共有サブフォルダを作成
階層型共有サブフォルダの名前変更または色の変更
階層型共有サブフォルダとその配下すべてを削除
階層型共有サブフォルダのレコードを作成
既存の階層型共有サブフォルダのレコードを更新
階層型共有サブフォルダのレコードを削除 (ゴミ箱、完全削除、リンク解除)
レコードを階層型共有サブフォルダにリンク
階層型共有サブフォルダのレコードのショートカットを一覧表示または管理 (2つ以上のフォルダにあるレコード)
フォルダ共有の付与または取り消し
レコード共有の付与、更新、取り消し、または所有権の移転
フォルダ内のすべてのレコードに対する共有権限を一括更新
レコードの所有権を別のユーザーへ移転
nsf-listコマンド
コマンド: nsf-list
詳細: ローカルにキャッシュされた階層型共有サブフォルダのフォルダとレコードを一覧表示します。既定ではフォルダとレコードの両方が表示されます。--folders または --records で絞り込み、--format で出力形式を制御できます。
スイッチ:
--folders フォルダのみ表示
--records レコードのみ表示
--format <{table, csv, json}> 出力形式の選択
table: 表形式で表示 (既定)csv: CSV形式で表示json: JSON形式で表示
--output <FILENAME> 出力ファイルのパス (table 形式では無視)
例:
階層型共有サブフォルダのフォルダとレコードをすべて一覧表示
階層型共有サブフォルダのフォルダのみ一覧表示
すべての階層型共有サブフォルダのレコードをJSON形式で表示
階層型共有サブフォルダの一覧全体をCSVファイルへエクスポート
nsf-getコマンド
コマンド: nsf-get
詳細: UIDまたはタイトルで階層型共有サブフォルダのレコードまたはフォルダの詳細を表示します。まず入力をフォルダとして解決し、見つからない場合はレコードとして解決します。レコードではフィールド値とユーザーごとの権限を、フォルダではユーザー/チームの権限と共有管理者を表示します。
パラメータ:
階層型共有サブフォルダのレコードまたはフォルダのUIDまたはタイトル
スイッチ:
--format <{detail, json}> 出力形式の選択
detail: 人が読める形式のレポート (既定)json: 機械可読なJSON
-v, --verbose 各アクセサの権限内訳をフラグ単位で表示
--unmask マスクされたフィールド値 (パスワード、シークレット、PIN) を表示。出力はstdoutのみに送られ、ログファイルには書き込まれません
例:
UIDで階層型共有サブフォルダオブジェクト (レコードまたはフォルダ) の詳細を表示
名前で階層型共有サブフォルダの詳細を表示
JSON形式でレコードの詳細を表示
マスクされたフィールドを平文で表示してレコードの詳細を表示
フラグ単位の権限内訳を含めてレコードの詳細を表示
--unmask は機密データ (パスワード、シークレット) をターミナルに表示します。使用前に安全な環境であることをご確認ください。
nsf-record-detailsコマンド
コマンド: nsf-record-details
詳細: v3 APIを使用して、1件以上の階層型共有サブフォルダのレコードのメタデータ (タイトル、タイプ、バージョン、リビジョン) を取得します。フィールド値をすべて出力せずにレコード属性を素早く確認する場合に便利です。
パラメータ:
1件以上のレコードUID (またはタイトル。UIDへ解決)
スイッチ:
--format <{table, json}> 出力形式の選択
table: 人が読めるテキスト (既定)json: JSON出力
例:
単一レコードのメタデータを表示
1回の呼び出しで複数レコードのメタデータを表示
レコードメタデータをJSONで出力
nsf-mkdirコマンド
コマンド: nsf-mkdir
詳細: v3 APIを使用して新しい階層型共有サブフォルダを作成します。ユーザーが階層型共有サブフォルダ内で cd している場合は現在のフォルダの子として作成され、それ以外の場合は階層型共有サブフォルダのルートに作成されます。
パラメータ:
フォルダ名 (// で名前内のリテラル / を埋め込めます。ネストしたパスは非対応: nsf-mkdir は1回の呼び出しでフォルダを1つだけ作成)
スイッチ:
--color <{none, red, orange, yellow, green, blue, gray}> フォルダの色を設定
--no-inherit 親フォルダの権限を継承しない (新規フォルダは共有なしで開始)
例:
現在の場所の下に「Engineering」という名前のフォルダを作成
青色の「Q1 Reports」フォルダを作成
親フォルダの権限を継承しないフォルダを作成
リテラル名にスラッシュを含むフォルダを作成:
Side/Project
同じ親の下に同じ名前のフォルダが既にある場合、nsf-mkdir は重複を作成せず、警告をログに記録して既存フォルダのUIDを返します。
nsf-rndirコマンド
コマンド: nsf-rndir
詳細: 階層型共有サブフォルダの名前変更、色の変更、または親権限継承設定の更新を行います。--name、--color、--inherit、--no-inherit のいずれか1つ以上が必要です。
パラメータ:
既存の階層型共有サブフォルダのパスまたはUID
スイッチ:
-n, --name <NAME> 新しいフォルダ名
--color <{none, red, orange, yellow, green, blue, gray}> フォルダの色を設定/変更
-q, --quiet 名前変更後の確認メッセージを抑制
例:
フォルダの名前を変更
UIDでフォルダの色を変更
1回の呼び出しで名前変更と色の変更を同時に実行
nsf-rmdirコマンド
コマンド: nsf-rmdir
詳細: 1つ以上の階層型共有サブフォルダとその配下すべてを削除します。確認を求める前に、必ずプレビューを実行します (影響: サブフォルダ、レコード、影響を受けるユーザーとチーム)。1回の呼び出しで削除できるフォルダは最大100件です。
パラメータ:
1つ以上のフォルダUIDまたは名前
スイッチ:
--operation, -o <{folder-trash, delete-permanent}> 削除操作 (既定: folder-trash)
folder-trash: 復元可能。フォルダはゴミ箱へdelete-permanent: 元に戻せない。フォルダとその内容は完全に破棄
--force, -f 確認プロンプトをスキップし、プレビュー後に即座に実行
--dry-run プレビューのみ実行。何も削除しない (--force と排他)
--quiet, -q フォルダごとの詳細を抑制し、サマリーのみ表示
例:
「Engineering」フォルダをゴミ箱へ移動 (確認あり)
プロンプトなしでUID指定のフォルダをゴミ箱へ
1回の呼び出しで複数フォルダをゴミ箱へ
フォルダとその内容を完全に削除 (元に戻せない)
実際には削除せず、削除の影響をプレビュー
--operation delete-permanent は取り消せません。対象フォルダ内のすべてのサブフォルダとレコードが完全に破棄されます。
nsf-record-addコマンド
コマンド: nsf-record-add
詳細: 新しい階層型共有サブフォルダのレコードを作成します。クラシックの record-add コマンドと同様で、すべての標準レコードタイプ、カスタムレコードタイプ、標準フィールド、カスタムフィールドに対応します。フィールド指定の詳細な例は --syntax-help をご参照ください。
パラメータ:
標準フィールド構文 <FIELD_NAME>=<FIELD_VALUE> を使った、スペース区切りのフィールド値のリスト。詳細は --syntax-help を参照
スイッチ:
-t, --title <TITLE> レコードタイトル (必須)
-rt, --record-type <TYPE> レコードタイプ (必須)。標準レコードタイプの一覧を参照
-n, --notes <NOTES> レコードのメモ
--folder <FOLDER> 新規レコードを格納するフォルダ名またはUID (省略時は階層型共有サブフォルダのルート)
-f, --force 警告 (例: 非対応の添付フィールド) を無視してレコードを作成
--syntax-help フィールド構文の詳細を表示して終了
例:
生成パスワード付きで「Engineering」フォルダにログインレコードを作成
階層型共有サブフォルダのルートに空の「classic」レコードを作成
フィールド構文のヘルプを表示して終了
nsf-record-add ではファイル添付はまだ利用できません。ファイルを添付する場合はクラシックの record-add コマンドを使用してください。
nsf-record-updateコマンド
コマンド: nsf-record-update
詳細: 既存の階層型共有サブフォルダのレコードを更新します。タイトル、メモ、レコードタイプ、個別フィールドを変更できます。-r を複数回指定すると、1回の呼び出しで複数レコードを更新できます。
パラメータ:
標準フィールド構文 <FIELD_NAME>=<FIELD_VALUE> を使った、スペース区切りのフィールド値のリスト
スイッチ:
-r, --record <RECORD> 更新対象のレコードパスまたはUID (必須、繰り返し可能)
-t, --title <TITLE> レコードタイトルを変更
-rt, --record-type <TYPE> レコードタイプを変更
-n, --notes <NOTES> レコードのメモを追加/変更
-f, --force 警告を無視
--syntax-help フィールド構文の詳細を表示して終了
例:
レコードの名前を変更
レコードのパスワードを置き換え (
$GENで再生成)1回の呼び出しで複数レコードのメモを更新
フィールド構文のヘルプを表示
nsf-rmコマンド
コマンド: nsf-rm
詳細: 1件以上の階層型共有サブフォルダのレコードを削除します。必ずプレビューを実行し (影響: フォルダ、追加の配置場所、影響を受けるユーザー/チーム)、確認を求めます。1回の呼び出しで削除できるレコードは最大500件です。3種類の削除操作に対応しています。
パラメータ:
1件以上のレコードUIDまたはタイトル
スイッチ:
--folder <FOLDER> 削除の文脈となるフォルダUIDまたは名前 (--operation unlink 使用時は必須)
--operation, -o <{owner-trash, folder-trash, unlink}> 削除操作 (既定: owner-trash)
owner-trash: 所有者のみがレコードを削除。所有者のゴミ箱へfolder-trash: 指定フォルダの文脈からレコードを削除してゴミ箱へunlink: 特定フォルダからのみレコードを削除。他のフォルダにあるレコード本体は残る (--folderが必要)
--force, -f 確認プロンプトをスキップし、プレビュー後に即座に実行
--dry-run プレビューのみ (--force と排他)
例:
所有者のゴミ箱へレコードを移動 (確認あり)
プロンプトなしでタイトル指定のレコードを強制削除
1回の呼び出しで複数レコードを削除
「Engineering」フォルダからのみレコードのリンクを解除 (他のフォルダには残す)
実際には削除せず、削除の影響をプレビュー
nsf-lnコマンド
コマンド: nsf-ln
詳細: 既存の階層型共有サブフォルダのレコードを階層型共有サブフォルダにリンクします。レコードは元のフォルダと宛先フォルダの両方に表示されます (ハードリンクに類似)。
パラメータ:
2つの位置引数: RECORD FOLDER
RECORD: レコードUID、タイトル、またはパスFOLDER: 宛先フォルダUIDまたは名前
例:
レコード (UID) を「Engineering」フォルダにリンク
レコード (タイトル) を「Marketing」フォルダにリンク
レコードを階層型共有サブフォルダのルートにリンク
nsf-shortcutコマンド
コマンド: nsf-shortcut <subcommand>
詳細: 階層型共有サブフォルダのレコードのショートカットを一覧表示または管理します。同じレコードが2つ以上のフォルダにリンクされている場合に「ショートカット」が存在します。
サブコマンド:
list <RECORD UID, FOLDER UID, or PATH>: 2つ以上のフォルダに存在するレコードを表示 (レコードまたはフォルダで絞り込み可能)keep <RECORD> <FOLDER>: 指定した1つのフォルダにのみレコードを残し、他のすべてのショートカットを削除
nsf-shortcut list
スイッチ:
--format <{table, csv, json}> 出力形式の選択 (既定: table)
--output <FILENAME> 出力先ファイル
例:
2つ以上のフォルダに存在するすべてのレコードを表示
ショートカット一覧をCSVファイルへエクスポート
特定レコード (UID) のショートカットのみ表示
「Engineering」フォルダ内のショートカットレコードのみ表示
nsf-shortcut keep
スイッチ:
-f, --force 余分なショートカットを削除する前にプロンプトを表示しない
例:
「Engineering」フォルダにのみ「API Key」を残し、他のすべてのフォルダから削除 (確認あり)
プロンプトなしで「Production」フォルダにのみレコードを残す
現在のフォルダにのみレコードを残す (フォルダ未指定時は現在のフォルダを使用。階層型共有サブフォルダ内で
cdしている必要あり)
nsf-shortcut keep が削除するのは リンク のみです。選択したフォルダに残すレコード本体は保持されます。
nsf-share-folderコマンド
コマンド: nsf-share-folder
詳細: 1つ以上の階層型共有サブフォルダに対する共有の付与または取り消しを行います。ユーザーのメール、チーム名/UID、およびフォルダ上の現在のすべてのユーザーとチームに展開される特殊な @existing 受信者に対応しています (呼び出し元は除く)。
パラメータ:
1つ以上のフォルダパスまたはUID (位置引数、繰り返し可能)
スイッチ:
-a, --action <{grant, remove}> フォルダ共有アクション (既定: grant)。grant は既存の共有も更新します
-e, --email <USER> 受信者: アカウントメール、チーム名、チームUID、またはフォルダ上のすべてのユーザーとチーム用の @existing (繰り返し可能)
-r, --role <ROLE> 権限ロール (既定: viewer)。grant では必須。指定可能な値:
viewershare-managercontent-managercontent-share-managerfull-manager
--expire-at <TIMESTAMP> 共有の有効期限。never またはISO日時 (例: 2027-01-01T00:00:00Z)
--expire-in <PERIOD> 共有の有効期限。never または相対期間 (例: 30d、6mo、1y、24h、30mi)
例:
単一ユーザーにviewerアクセスを付与
1回の呼び出しで複数ユーザーにcontent-managerアクセスを付与
チーム (チーム名) にfull-managerアクセスを付与
30日後に自動失効するviewerアクセスを付与
フォルダから単一ユーザーを削除
フォルダから既存のすべてのユーザーとチームを削除 (呼び出し元は除く)
--expire-at と --expire-in は同時に指定できません。
nsf-share-recordコマンド
コマンド: nsf-share-record
詳細: 階層型共有サブフォルダのレコードの共有を管理します。付与、更新、取り消し、所有権の移転に対応しています。record 引数にはレコードUID、レコードタイトル、またはフォルダを指定できます (フォルダの場合はフォルダ内のすべてのレコードが処理され、-R と組み合わせるとサブフォルダも再帰的に対象になります)。
パラメータ:
レコードのパス/UIDまたはフォルダのパス/UID (位置引数)
スイッチ:
-e, --email <EMAIL> 受信者のメール (必須、繰り返し可能)
-a, --action <{grant, revoke, owner}> 共有アクション (既定: grant)
grant: レコードを共有 (既存の共有も更新)revoke: 共有を削除owner: レコードの所有権を移転 (受信者は1名のみ)
-r, --role <ROLE> 権限ロール。grant では必須。指定可能な値: viewer、share-manager、content-manager、content-share-manager、full-manager
-R, --recursive フォルダ内およびサブフォルダ内のすべてのレコードにコマンドを適用
--contacts-only 既知の連絡先へのみ共有 (--force なしでは未知のメールアドレスを拒否)
-f, --force 確認プロンプトをスキップ (例: --contacts-only の確認)
--dry-run 変更をコミットせず権限変更を表示
--expire-at <EXPIRE_AT> 共有の有効期限。never またはUTC日時 (例: 2027-01-01T00:00:00Z)
--expire-in <PERIOD> 共有の有効期限。never または相対期間 (例: 30d、6mo、1y)
例:
単一ユーザーをviewerとしてレコードを共有
1回の呼び出しで複数ユーザーにレコードを共有
「Engineering」フォルダとそのサブフォルダ内のすべてのレコードを単一ユーザーと共有
30日で失効する共有を設定
共有を取り消し
レコードの所有権を移転 (移転完了後はアクセスを失います)
コミットせず共有をプレビュー
-a owner はレコードの所有権を移転します。移転が受理されると、レコードへのアクセスは失われます。受信者は1名のみ指定できます。
nsf-record-permissionコマンド
コマンド: nsf-record-permission
詳細: 階層型共有サブフォルダ内のすべてのレコードに対する共有権限を一括更新します。フォルダ全体の権限を正規化する場合に便利です (例: 「Production フォルダ内のすべての共有をviewerにする」)。親共有フォルダから継承された権限にも対応し、継承行を上書きするために新しい直接共有を作成します。
パラメータ:
フォルダパスまたはフォルダUID (位置引数、任意: 省略時は階層型共有サブフォルダのルート)
スイッチ:
-a, --action <{grant, revoke}> 実行するアクション (必須)
grant: 該当するすべての共有を--roleに設定revoke: 該当するすべての共有を削除 (--role指定時はそのロールのみ)
-r, --role <ROLE> 付与するロール、または取り消しのフィルタ。指定可能な値: viewer、share-manager、content-manager、content-share-manager、full-manager
-R, --recursive フォルダ内およびサブフォルダ内のすべてのレコードに変更を適用
--dry-run 変更をコミットせず権限変更を表示
-f, --force 確認なしで変更を適用
例:
「Engineering」フォルダ内のすべてのレコード共有を
viewerに設定「Engineering」とそのサブフォルダ内のすべてのレコード共有を
content-managerに設定「Engineering」内のすべてのレコードについて、所有者以外のすべての共有を取り消し
「Engineering」内のレコードについて、
viewer共有のみを取り消しコミットせず計画された権限変更をプレビュー
確認なしで変更を適用
親共有フォルダから継承された共有は、レコードレベルでは取り消せません。親共有フォルダから削除する必要があります。該当する共有はskippedとして一覧表示されます。
nsf-transfer-recordコマンド
コマンド: nsf-transfer-record
詳細: 1件以上の階層型共有サブフォルダのレコードの所有権を別のユーザーへ移転します。移転が成功すると、元の所有者はレコードへのアクセスを失います。より細かい制御には nsf-share-record -a owner をご参照ください。
パラメータ:
2つの位置引数: RECORD_UIDS... NEW_OWNER_EMAIL
1件以上のレコードUID (またはタイトル) のあとに
新しい所有者のメールアドレス
例:
レコードの所有権を別のユーザーへ移転
複数レコードの所有権を同じ新しい所有者へ移転
所有権を移転すると、レコードへのアクセスは失われます。実行前に新しい所有者が正しいことをご確認ください。
ロールリファレンス
複数の階層型共有サブフォルダ共有コマンドで --role オプションを指定できます。利用可能なロールを権限の高い順に示します。
viewer
レコードへの読み取り専用アクセス
share-manager
他ユーザーのアクセス管理が可能 (コンテンツは編集不可)
content-manager
レコード内容の編集が可能 (共有は管理不可)
content-share-manager
レコード内容の編集と共有の管理の両方が可能
full-manager
編集、共有、委任の完全制御。レコード/フォルダの共有管理者に相当
操作リファレンス
nsf-rm と nsf-rmdir は、削除の実行方法を決める --operation フラグを受け付けます。
owner-trash
nsf-rm (既定)
所有者のみが削除: レコードは所有者のゴミ箱へ
folder-trash
nsf-rm、nsf-rmdir (フォルダの既定)
指定フォルダの文脈からレコード/フォルダを削除してゴミ箱へ。ゴミ箱から復元可能
unlink
nsf-rm
指定フォルダからのみレコードを削除。レコード本体は他のフォルダに残る
delete-permanent
nsf-rmdir
元に戻せない: フォルダとその内容を完全に破棄
最終更新