フォルダコマンド

フォルダーとその内容に関連するコマンドの説明

概要

このページではフォルダー関連のコマンドを示します。現時点では以下のコマンドを扱います。

1. List Folderコマンド

2. Move Folderコマンド

3. Remove Folderコマンド

4. Create Directoryコマンド

5. Edit Directoryコマンド

6. Change Directoryコマンド

7. Get Keeper Folderコマンド (PowerShellのみ)

List Folderコマンド

指定したUIDに関する情報を返します。UIDはレコード、フォルダー、共有フォルダ、チームのいずれかに対応できます。情報はJSONとして、または詳細のリストとして出力できます。

DotNet CLI

コマンド: ls

フラグ:

• l : 詳細

例:

My Vault> ls -l
  #  Folder UID              Name                           
---  ----------------------  -------------------------------
  1  folder_uid              Actest/                        
  2  folder_uid              ChecKRustWindows               
  3  folder_uid              Example-shared-folder          
  4  folder_uid              main_credentials_shared_folder 
  5  folder_uid              main_folder_for_init_test      
                      

DotNet SDK

DotNet SDKでの現在の実装は、指定したUIDを複数のカテゴリから検索する流れに従います。

public bool TryGetFolder(string folderUid, out FolderNode node)

続いて、次を使ってノードからサブフォルダーとそのすべてのデータを取得します。

var subFolders = node.Subfolders;

これらのサブフォルダーのデータにアクセスできます。

Power Commander

コマンド: Get-KeeperFolders

エイリアス: kfolders

パラメータ:

• -Filter (string, optional) - 名前でフォルダーを絞り込む。ワイルドカード (* および ?) に対応。例: "Engineering*"

• -Type (string, optional) - フォルダータイプで絞り込む: 'All' (既定)、'User'、または 'Shared'

• -IncludeRoot (switch, optional) - 結果にルートフォルダーを含める

• -AsObject (switch, optional) - 整形表示ではなくパイプライン用のフォルダーオブジェクトを返す

• -Verbose (switch, optional) - 完全なフォルダーパスを含む詳細情報を表示する

例:

PS> Get-KeeperFolders -Type Shared -IncludeRoot -Verbose          

Found 9 folder(s)

UID                    Name                           Type               Subfolders Records Path
---                    ----                           ----               ---------- ------- ----
Yi_OxwTV2tdBWi-_Aegs_w Demo Folder                    SharedFolder                1       4 /Demo Folder/
IjMo9BzlhPmZnGRQI8feYg My folder                      SharedFolderFolder          1       0 /Demo Folder/My folder/
FsCYGSOz71gkbcg7okedmQ My subfolder                   SharedFolderFolder          0       0 /My subfolder/
8N6xqMChTWAL-r_wIdzV8A my_share                       SharedFolder                1       2 /my_share/
jB6_X9sDvc2ZQy4rZtSt3A New Sub-Folder                 SharedFolderFolder          1       0 /New Sub-Folder/
Lp0G8YP3aDEj627K_I2_BA New Sub-Folder                 SharedFolderFolder          0       0 /Demo Folder/My folder/New Sub-Folder/
h0dtYN_8hpUWyeGHRj5jRA PowerCommanderCreatedFolder    SharedFolderFolder          0       0 /New Sub-Folder/PowerCommanderCreatedFolder/
kxR69Qfymrrx7SKtzpwFlg test_share_folder_folder       SharedFolderFolder          1       1 /my_share/test_share_folder_folder/
KjcKBnhzkVrgBVH6ujTlqA testrtg                        SharedFolderFolder          0       1 /my_share/test_share_folder_folder/testrtg/

Python CLI

コマンド: ls

オプション:

• -l --list リスト形式で出力する

• -f --folders 出力にフォルダー名のみ表示する

• -r --records 出力にレコードを表示する

• -v --verbose 詳細出力を表示する

例:

My Vault> ls -l
  #  Flags    UID                     Name                                                      Type
---  -------  ----------------------  --------------------------------------------------------  -----------------
  1  f---     folder_uid              User-ks

Python SDK

関数: get_folder

get_folder(self, folder_uid: str) -> Optional[vault_types.Folder]

例:

 folder = vault.vault_data.get_folder(folder_uid)

Move Folderコマンド

ボルト内のある場所から別の場所へレコードまたはフォルダーを移動します。

DotNet CLI

コマンド: mv

フラグ:

• --link : 移動元を削除しない

• source record or folder (pos. 0) : 必須。移動元のレコードまたはフォルダー

• destination folder (pos. 1) : 必須。移動先フォルダー

例:

My Vault > mv <source_record/source_folder> <destination_folder>

DotNet SDK

メソッド:

public async Task MoveFolder(string srcFolderUid, string dstFolderUid, bool link = false)

引数 :

srcFolderUid - 移動元フォルダーのUID。別の場所へ移動するフォルダー。

dstFolderuid - 上記フォルダーが移動される先のフォルダーのUID。

link - trueのとき、移動元からソースフォルダーを削除せず、移動先の新しいフォルダーをソースにリンクする。falseのとき、ソースから移動先へフォルダーを移動する。

Power Commander

コマンド: Move-RecordToFolder

エイリアス: kmv

フラグ :

• -Records : レコードのUID

• -Folder : フォルダーのUID

• -Link

例:

PS > Move-RecordToFolder -Records record_uid -Folder folder_uid

Python CLI

コマンド: mv

パラメータ: 必須

• Source pos 0 必須 - 移動元フォルダーまたはレコードのUIDまたはパス

• Destination pos 1 必須 - 移動先フォルダーのUIDまたはパス

オプション:

• -l, --link 移動元を削除しない

• -f, --force 確認を出さない

• -R, --recursive 検索パターンをフォルダーにも適用する

• -s, --can-reshare {on, off} 「共有可」レコード権限を適用する

• -e, --can-edit {on, off} 「編集可」レコード権限を適用する

例:

My Vault> mv <source_record/source_folder> <destination_folder>

Python SDK

関数: move_vault_objects

例:

# here source uids are folder uids 
# paths to the records inside is record_paths
record_management.move_vault_objects(
     context.vault,
     src_objects=itertools.chain(source_uids, record_paths),
     dst_folder_uid=dst_folder.folder_uid,
     is_link=kwargs.get('link') is True,
     can_edit=can_edit, 
     can_share=can_share,
     on_warning=on_warning)

Remove Folderコマンド

ボルト内のある場所から別の場所へレコードまたはフォルダーを移動するか、名前を変更します。

DotNet CLI

コマンド: rmdir

フラグ:

• (pos. 0) : フォルダー名またはUID。フォルダー削除に使用する。

例:

My Vault> rmdir some_new_folder/
1 Shared Folder(s) will be deleted.
Note: If the last reference to a record is removed, the record can be found in the owner's trash can. If the trash can is then emptied, the record is no longer recoverable.
Type "yes" to confirm, <Enter> to cancel
> yes

DotNet SDK

メソッド:

public Task DeleteFolder(string folderUid)

引数 :

folderUid - 削除するフォルダー

Power Commander

コマンド:

PS> Remove-KeeperFolder test_folder_for_delete 

フラグ:

Name - 削除するフォルダーの名前またはUID

Python CLI

コマンド: rmdir

パラメータ:

• folder 削除するフォルダーのパスまたはUID (必須)

オプション:

• -f --force 確認プロンプトを省略する

• -q --quiet 削除中にフォルダー情報を表示しない

例:

My Vault> rmdir deleted_folder

The following folder(s) will be removed:
deleted_folder

1 Personal Folder(s) will be deleted.
Note: If the last reference to a record is removed, the record can be found in the owner's trash can. If the trash can is then emptied, the record is no longer recoverable.
 
Do you want to proceed with the folder deletion? [y/n]: y

Python SDK

関数: delete_vault_objects

 delete_vault_objects(vault: vault_online.VaultOnline,
                         vault_objects: Iterable[Union[str, vault_types.RecordPath]],
                         confirm: Optional[Callable[[str], bool]]=None) -> None:

例:

 record_management.delete_vault_objects(context.vault, list(folder_uids), delete_confirmation)

Treeコマンド

ボルト内のフォルダーとレコードの階層を、Unixのtreeコマンドに似たツリー表示で示します。ディレクトリ構造を表示します。

DotNet CLI

コマンド : tree

フラグ :

• folder (pos. 0) : フォルダーのパスまたはUID

例:

My Vault > tree

My Vault
 +-- New Test Folder
 |   +-- example-normal-folder
 |       +-- test-example-subfolder

DotNet SDK

メソッド: 非対応

Power Commander

コマンド : 近日公開

Python CLI

コマンド : tree

オプション:

• -v, --verbose - 名前に加えて内部ID (例: フォルダーUID) を表示する。

• -r, --records - 各フォルダーに含まれるレコードを表示する。

• -s, --shares - 各共有フォルダーの共有権限の詳細を表示する。

• -hk, --hide-shares-key - 共有権限の凡例を隠す。--sharesと併用したときのみ有効。既定では--shares有効時に凡例を表示する。

• -t, --title - フォルダー構造の出力の上に任意のタイトルを表示する。

• folder - 表示するフォルダーのパスまたはUID。省略時はルートフォルダーを表示する。

例:

My Vault> tree "Test-normal-folder"
Test-normal-folder
 +-- example-folder
 +-- Shared-Folder-Example [Shared]
 +-- Test PowerCommander Folder [Shared]

Python SDK

非対応

Create Directoryコマンド

レコードや他のフォルダーを整理するために、Keeperボルト内に新しいフォルダーを作成します。

DotNet CLI

コマンド : mkdir

フラグ :

• folder name : 必須。フォルダー名

• -s, --shared (Default: false) : 共有フォルダー

• --manage-users : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

• --manage-records : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

• --can-share : 共有を既定とする。trueまたはfalse。既定はfalse。

• --can-edit : 編集を既定とする。trueまたはfalse。既定はfalse。

例:

My Vault>  mkdir -s "Test-Dotnet-Cli-Folder" --manage-users true  --manage-records true --can-share true  --can-edit true

DotNet SDK

メソッド:

Task<FolderNode> CreateFolder(string name, string parentFolderUid = null,
            SharedFolderOptions sharedFolderOptions = null);

フラグ :

name - 作成するフォルダーの名前。作成されるフォルダーレコードのタイトルになる。

parentFolderUid - 親フォルダーのUID。

SharedFolderOptions:

ManageUsers : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

ManageRecords : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

CanShare : 共有を既定とする。trueまたはfalse。既定はfalse。

CanEdit : 編集を既定とする。trueまたはfalse。既定はfalse。

Power Commander

コマンド : Add-KeeperFolder または kmkdir

フラグ :

• -Name : 作成するフォルダーの名前

• -ParentFolderUid : 現在のフォルダーを作成する親フォルダーのUID

• -Shared : 共有フォルダーにするか通常フォルダーにするか。共有フォルダーを作成する場合はtrue、そうでなければfalse。

• -CanEdit : 編集を既定とする。trueまたはfalse。既定はfalse。

• -CanShare : 共有を既定とする。trueまたはfalse。既定はfalse。

• -ManageUsers : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

• -ManageRecords : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

例:

PS > Add-KeeperFolder -Name "Test PowerCommander Folder" -ParentFolderUid folder_uid -Shared -CanEdit -CanShare 

FolderUid     Name            FolderType     ParentUid           SubfolderCount   RecordCount
                                                                                                     t
---------     ----            ----------     ---------           --------------   ----------
Folder UID    Test Folder     SharedFolder   Parent_folder_uid    0               0

Python CLI

コマンド: : mkdir

パラメータ:

• folder : フォルダー名 (必須)

オプション:

• -sf, --shared-folder : 共有フォルダーを作成する

• -uf, --user-folder :ユーザーフォルダーを作成する

• -a, --all : 既定ですべての権限を誰にでも付与する

• -u, --manage-users : 既定で誰でもユーザーを管理できる

• -r, --manage-records : 既定で誰でもレコードを管理できる

• -s, --can-share : 既定で誰でもレコードを共有可能

• -e, --can-edit : 既定で誰でもレコードを編集可能

例:

My Vault> mkdir -sf "Test-Python-Cli-Folder" -s -e
folder_uid ##Outputs created folder uid

Python SDK

関数: add_folder

add_folder(vault: vault_online.VaultOnline, folder_name: str, is_shared_folder: bool=False,
               parent_uid: Optional[str]=None, manage_records: Optional[bool]=None, manage_users: Optional[bool]=None,
               can_share: Optional[bool]=None, can_edit: Optional[bool]=None)

例:

folder_uid = folder_management.add_folder(
                context.vault, folder_name, is_shared_folder, base_folder.folder_uid, manage_users, manage_records, can_edit, can_share)

Update Folderコマンド

ボルト内の既存のKeeperフォルダーを編集するために使います。UIDまたは名前でフォルダーを解決し、必要に応じて共有フォルダーの権限を設定します。

DotNet CLI

コマンド : update-dir

フラグ :

• --name : フォルダーの新しい名前 (リネーム)。

• --manage-users : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

• --manage-records : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

• --can-share : 共有を既定とする。trueまたはfalse。既定はfalse。

• --can-edit : 編集を既定とする。trueまたはfalse。既定はfalse。

例:

My Vault>  update-dir "Old Folder Name" --name "New Project Folder" --can-edit true --can-share true --manage-users true --manage-records true

DotNet SDK

メソッド:

Task<FolderNode> UpdateFolder(string folderUid, string newName, SharedFolderOptions sharedFolderOptions = null);

フラグ :

folderUid - フォルダーのUID。

newName - フォルダーの新しい名前 (リネーム)。

SharedFolderOptions :

ManageUsers : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

ManageRecords : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

CanShare : 共有を既定とする。trueまたはfalse。既定はfalse。

CanEdit : 編集を既定とする。trueまたはfalse。既定はfalse `.

Power Commander

コマンド : Edit-KeeperFolder

フラグ :

• -Uid : 編集対象のフォルダーを特定するフォルダーUIDまたは名前。

• -Name : フォルダーの新しい名前 (リネーム)。

• -Shared : 共有フォルダーにするか通常フォルダーにするか。共有フォルダーにする場合はtrue、そうでなければfalse。

• -CanEdit : 編集を既定とする。trueまたはfalse。既定はfalse。

• -CanShare : 共有を既定とする。trueまたはfalse。既定はfalse。

• -ManageUsers : ユーザーの管理を既定とする。trueまたはfalse。既定はfalse。

• -ManageRecords : レコードの管理を既定とする。trueまたはfalse。既定はfalse。

例:

PS > Edit-KeeperFolder -Uid QpR86NvOnfvGYf_urfltFw  -Name A122

FolderUid              Name FolderType ParentUid SubfolderCount RecordCount
---------              ---- ---------- --------- -------------- -----------
QpR86NvOnfvGYf_urfltFw A122 UserFolder           0              0

Python CLI

未実装

Python SDK

未実装

Change Directoryコマンド

Keeperはレコードとフォルダーを整理するためにディレクトリ構造を使います。このコマンドはKeeperフォルダー間を移動するのに使います。

DotNet CLI

コマンド : cd

フラグ :

• folder destination or Uid

例:

My Vault> cd Test-Dotnet-Cli-Folder

My Vault/Test-Dotnet-Cli-Folder> 

DotNet SDK

メソッド: 対象外

例:

1. ユーザーからフォルダーUIDまたは名前を取得する。

2. TryResolvePath関数でパスを解決し、存在すれば出力フォルダーをnode変数に入れる。

3. nodeがnullでなければ、当該ノードのFolderUidが現在のボルトフォルダーになる。

vault.TryResolvePath(name, out var node)
vault.CurrentFolder = node.FolderUid;

Power Commander

コマンド : Set-KeeperLocation または kcd

フラグ :

• -Path - 移動先フォルダーへのパス。名前のみでもよい。

例:

PS > Set-KeeperLocation /Test-normal-folder

コマンド : Get-KeeperLocation

例:

	Get current Keeper folder path
PS >  Get-KeeperLocation

Path
----
\

Python CLI

コマンド: cd

パラメータ:

• FOLDER フォルダーのパスまたはUID (必須)

例:

My Vault> cd folder_uid
My Vault/Test-Python-Cli-Folder>

Python SDK

非対応

Get Keeper Folderコマンド

Power Commander

コマンド: Get-KeeperFolder

Keeperフォルダーの詳細情報を取得する。

フラグ:

Uid - 詳細を表示するフォルダーのUID。

使用法:

PS> Get-KeeperFolder abcdefg(uid)
PS> Get-KeeperFolder abcdefg(uid) -AsObject

例:

PS> Get-KeeperFolder _56dJ6GUKYDSp4NfRomIaa

    Folder UID          : _56dJ6GUKYDSp4NfRomIaa
    Folder Type         : SharedFolder
    Name                : ChecK123455
    Shared Folder UID   : _56dJ6GUKYDSp4NfRomIaa
    Full Path           : /ChecK123455/
    Subfolders          : 2
    Records             : 10