# folderコマンド

## `folder` コマンド <a href="#folder-command-1" id="folder-command-1"></a>

**説明:** ボルトからフォルダを一覧表示、作成、更新、削除します。KSMアプリケーションに共有されているフォルダ内でのみ利用できます。`folder` コマンドでは、共有フォルダ内のサブフォルダを管理します。

**パラメータ:**

実行するサブコマンド

形式: **`ksm folder <サブコマンド>`**

**サブコマンド:**

| サブコマンド   | 説明                                 |
| -------- | ---------------------------------- |
| `list`   | アプリケーションに関連付けられているすべてのフォルダを一覧表示します |
| `add`    | ボルトに新しいサブフォルダを追加します                |
| `update` | フォルダの名前を変更する                       |
| `delete` | ボルトからフォルダを削除する                     |

### **list** <a href="#list" id="list"></a>

アプリケーションに関連付けられているすべてのフォルダを一覧表示します。

`ksm folder list`

* オプションパラメータ:
* `--json` 結果をJSON形式で返します。
* `-f, --folder <folder UID>` 選択したフォルダUID内のフォルダ/レコードのみを一覧表示します。
* `-r, --recursive` 選択したフォルダUID内のすべてのフォルダ/レコードを、すべてのサブフォルダも含めて一覧表示します。
* `-l, --list-records` 出力にフォルダレコード情報を含めます。

{% hint style="info" %}
パラメータを省略した場合は、KSMアプリに共有されているすべてのフォルダが一覧表示されます。`--list-records` を指定した場合は、フォルダに属さず、KSMアプリに直接共有されているレコードも含め、すべてのレコードが表示されます。
{% endhint %}

**例1:** 表形式

```
$ ksm folder list

 Type Parent                  UID                     Title
 ---- ----------------------- ----------------------- ---------------
 dir                          vZdNYOi7Oh1q6pvI9jY8KA  Applications
 dir                          EVvnsKbrlYHMi4HVTBn3-w  Databases
 dir  EVvnsKbrlYHMi4HVTBn3-w  Bj9bNJjSFobG-VE7MImaIA  Oracle
```

**例2:** JSON形式

```
$ ksm folder list --json
[
    {
        "type": "dir",
        "parent_uid": "",
        "uid": "vZdNYOi7Oh1q6pvI9jY8KA",
        "title": "Applications"
    },
    {
        "type": "dir",
        "parent_uid": "",
        "uid": "EVvnsKbrlYHMi4HVTBn3-w",
        "title": "Databases"
    },
    {
        "type": "dir",
        "parent_uid": "EVvnsKbrlYHMi4HVTBn3-w",
        "uid": "Bj9bNJjSFobG-VE7MImaIA",
        "title": "Oracle"
    }
]
```

### add <a href="#add" id="add"></a>

指定された親フォルダの下にサブフォルダを新規作成します。作成できるのは、KSMアプリに共有されている共有フォルダ (およびその配下のサブフォルダ) に限られ、新規の共有フォルダは作成できません。

{% hint style="info" %}
作成に成功すると、フォルダのUIDが標準出力に出力されます。ほかにメッセージがある場合は標準エラー出力に出力されます。
{% endhint %}

`ksm folder add --parent-folder <フォルダUID> --title <フォルダタイトル>`

必須パラメータ:

`--parent-folder, -f` サブフォルダを作成する親フォルダのUID。

`--title, -t` 新しいフォルダのタイトル。

**例:**

```
ksm folder add --parent-folder vZdNYOi7Oh1q6pvI9jY8KA --title NewApp

The following is the new folder UID ...
Ai9iFYWf6EOE0T9fVAynBg
```

### **update** <a href="#update" id="update"></a>

フォルダの名前を変更します。

`ksm folder update --folder <フォルダUID> --title NEW_TITLE`

パラメータ:

* `--folder, -f` 名前を変更する対象フォルダのUID。
* `--title, -t` 新しいフォルダのタイトル。

**例:**

```
$ ksm folder update --folder Ai9iFYWf6EOE0T9fVAynBg --title NewAppTitle
```

### **delete** <a href="#delete" id="delete"></a>

KSMアプリに共有されているボルト内のフォルダを削除します。

`ksm folder delete <フォルダUID>`

パラメータ:

* `<FOLDER UID>` 削除するフォルダのUID (必須)
* `-f, --force` 空でないフォルダを強制的に削除します (オプション)

**例:**

```shell
$ ksm folder delete Ai9iFYWf6EOE0T9fVAynBg

UID                     Response Code Error
----------------------- ------------- -----
Ai9iFYWf6EOE0T9fVAynBg  ok
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/keeperpam/jp/secrets-manager/secrets-manager-command-line-interface/folder-command.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.