> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/components/io/directory.md).

# Directory

Allows you to list, create, delete or rename a directory in the server file system.

## Component Signature

```
<bx:Directory action=[string]
directory=[string]
name=[string]
filter=[string]
mode=[string]
sort=[string]
newDirectory=[string]
destination=[string]
recurse=[boolean]
type=[string]
listInfo=[string]
createPath=[boolean] />
```

### Attributes

| Atrribute      | Type      | Required | Description                                                                                                                                                    | Default                                                                 |
| -------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `action`       | `string`  | `true`   | The action to perform (list, create, delete, rename)                                                                                                           | `list`                                                                  |
| `directory`    | `string`  | `true`   | The directory to perform the action on                                                                                                                         |                                                                         |
| `name`         | `string`  | `false`  | Name for output record set.                                                                                                                                    |                                                                         |
| `filter`       | `string`  | `false`  | Filter applied to returned names. For example: \*.bx You can use a pipe ("                                                                                     | <p>") delimiter to specify multiple filters. For example:<br>\*.bxm</p> |
| `mode`         | `string`  | `false`  | <p>Applies only to UNIX and Linux. Permissions. Octal values of Unix chmod command. Assigned to owner, group, and other, respectively.<br>For example: 777</p> |                                                                         |
| `sort`         | `string`  | `false`  | Query column(s) by which to sort directory listing. Delimited list of columns from query output.                                                               |                                                                         |
| `newDirectory` | `string`  | `false`  | The new directory name for the rename action.                                                                                                                  |                                                                         |
| `destination`  | `string`  | `false`  |                                                                                                                                                                |                                                                         |
| `recurse`      | `boolean` | `false`  | Recurse into subdirectories.                                                                                                                                   | `false`                                                                 |
| `type`         | `string`  | `true`   | Type of directory listing to return (dir, file, all).                                                                                                          | `all`                                                                   |
| `listInfo`     | `string`  | `true`   | Information to return in the listing (name, all).                                                                                                              | `all`                                                                   |
| `createPath`   | `boolean` | `false`  | Whether to create all paths necessary to create the directory path.                                                                                            | `true`                                                                  |

## Examples

### List Files in Directory (Script Syntax)

Returns a query

[Run Example](https://try.boxlang.io/?code=eJzLrfTJLC5RsFVIySxKTS7JLwLzNRRSKwoS81ICEksyNBSU9PSVFDR1FNISc4pTdRSUCktTiyqBItZcAJ%2BQE6M%3D)

```java
myList = directoryList( expandPath( "./" ), false, "query" );

```

Result: \[ { name : ".DS\_Store", size : 6148, type : "File", dateLastModified : {ts '2025-05-26 18:15:41'}, attributes : "RWH", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : ".ortus", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 18:13:41'}, attributes : "RWXH", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "Application.bx", size : 42, type : "File", dateLastModified : {ts '2025-05-24 04:42:10'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "assets", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 17:03:57'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "bifs", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 22:10:29'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "components", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 22:10:12'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "compressed\_test.txt.gz", size : 340, type : "File", dateLastModified : {ts '2025-05-26 17:20:07'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "example.bxm", size : 899, type : "File", dateLastModified : {ts '2025-05-26 11:05:52'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "example.bxm", size : 876, type : "File", dateLastModified : {ts '2025-05-26 11:01:38'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "filepath", size : 23, type : "File", dateLastModified : {ts '2025-05-26 22:10:14'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "images", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 17:20:07'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "index.bxm", size : 10048, type : "File", dateLastModified : {ts '2025-05-26 22:11:54'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "MyDestinationDirectory", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 17:20:07'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "myNewFileName.txt", size : 57, type : "File", dateLastModified : {ts '2025-05-26 16:38:57'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "new", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 17:20:07'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "new\_directory", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 18:13:41'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "Page.bx", size : 1253, type : "File", dateLastModified : {ts '2025-05-24 11:23:02'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "server.json", size : 108, type : "File", dateLastModified : {ts '2025-05-24 10:35:52'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "setup\_db.sql", size : 480, type : "File", dateLastModified : {ts '2025-05-24 04:42:10'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "some", size : 0, type : "Dir", dateLastModified : {ts '2025-05-26 18:13:42'}, attributes : "RWX", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "test.txt", size : 614, type : "File", dateLastModified : {ts '2025-05-26 17:20:07'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" }, { name : "testcase.txt", size : 0, type : "File", dateLastModified : {ts '2025-05-28 22:10:14'}, attributes : "RW", mode : "", directory : "/Users/scottsteinbeck/Downloads/BL-1468" } ]

### Create a Directory (Script Syntax)

```java
directoryCreate( expandPath( "./new_directory" ) );

```

### Delete a Directory (Script Syntax)

Directory Delete

```java
directoryDelete( expandPath( "./my_directory" ) );

```

### Rename a Directory (Script Syntax)

```java
directoryRename( expandPath( "./my_directory" ), expandPath( "./new_directory" ) );

```

### List File in Directory (Tag Syntax)

Directory List

```java
<bx:directory action="list" directory="#expandPath( "./" )#" recurse="false" name="myList">
```

### Create a Directory (Tag Syntax)

```java
<bx:directory action="create" directory="#expandPath( "./new_directory" )#">
```

### Delete a Directory (Tag Syntax)

```java
<bx:directory action="delete" directory="#expandPath( "./my_directory" )#">
```

### Rename a Directory (Tag Syntax)

```java
<bx:directory action="rename" directory="#expandPath( "./my_directory" )#" newdirectory="#expandPath( "./new_directory" )#">
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/components/io/directory.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.