# Folder

## Introduction

The Folder library in Automate provides actions to automate folder-related operations, simplifying the management of directories within workflows.

The purpose of the Folder library is to offer a convenient way to create, copy, delete, and move folders seamlessly within the automation process. These actions are essential for efficient folder organization and maintenance.

## What is Folder?

The Folder component within Automate allows users to perform essential folder operations directly within their workflows. This component includes actions to create, copy, delete, and move folders with ease.

#### Key Features

* <mark style="color:orange;">**Copy**</mark><mark style="color:orange;">: Duplicate an existing folder to another location.</mark>
* <mark style="color:orange;">**Delete**</mark><mark style="color:orange;">: Remove a specified folder from the system.</mark>
* <mark style="color:orange;">**Move**</mark><mark style="color:orange;">: Transfer a folder to a designated location.</mark>
* <mark style="color:orange;">**New Folder**</mark><mark style="color:orange;">: Create a new folder at a specified path.</mark>

## How To Use Action

### Copy

<figure><img src="/files/7uD5dteilNY3XY0B67eY" alt=""><figcaption></figcaption></figure>

**Description:** The **Copy** action is used to duplicate a folder to another location.

**Usage:**

1. **Source Folder:**
   * <mark style="color:green;">Select the folder to be copied.</mark>
2. **Destination Path:**
   * <mark style="color:green;">Specify the path where the copied folder will be placed.</mark>
   * <mark style="color:green;">Check "Overwrite an existing folder" to replace existing folders.</mark>
   * <mark style="color:green;">Optionally specify the desired folder size.</mark>

### Delete

<figure><img src="/files/1Px9rUY0ldHOQgsd5w7v" alt=""><figcaption></figcaption></figure>

**Description:** The **Delete** action removes a specified folder from the system.

**Usage:**

1. **Folder Path:**
   * <mark style="color:green;">Select the path of the folder to be deleted.</mark>
   * <mark style="color:green;">This folder will be permanently removed.</mark>

### Move

<figure><img src="/files/eDPBDxXuqrtwnXv8GR1c" alt=""><figcaption></figcaption></figure>

**Description:** The **Move** action transfers a folder to a specific location.

**Usage:**

1. **Source Folder Path:**
   * <mark style="color:green;">Select the folder to be moved.</mark>
2. **Destination Folder Path:**
   * <mark style="color:green;">Specify the path of the destination folder.</mark>

### New Folder

<figure><img src="/files/ttVwpVYZCokpIyR6yKRK" alt=""><figcaption></figcaption></figure>

**Description:** The **New Folder** action creates a new folder at a specified path.

**Usage:**

1. **Folder Path:**
   * Specify the path of the new folder to be created.
   * <mark style="color:green;">**Example:**</mark><mark style="color:green;">**&#x20;**</mark><mark style="color:green;">**`C:\\Program Files`**</mark>

### **Get Files in Folder**

<figure><img src="/files/ygVvph1ZG0dYA2fW3TTI" alt=""><figcaption></figcaption></figure>

**Description:** Brief overview of the action's purpose.

**Purpose:** Detailed explanation of why the action is used.

**Usage:** Instructions on how to use the action.

**Inputs:**

* <mark style="color:green;">Folder Path (Required): Specify the path of the folder from which files will be retrieved.</mark>
* <mark style="color:green;">Assign files in folder to variable (Required): Select a variable of type array to store the list of files.</mark>

**Outputs:**

* Expected results or responses from the action.

### **Get Properties**

<figure><img src="/files/VdBt3euhEdXAwXr364HX" alt=""><figcaption></figcaption></figure>

**Description:** Brief overview of the action's purpose.

**Purpose:** Detailed explanation of why the action is used.

**Usage:** Instructions on how to use the action.

**Inputs:**

* <mark style="color:green;">Folder Path (Required): Specify the path of the folder whose properties will be retrieved.</mark>
* <mark style="color:green;">Assign folder properties to variable (Required): Select a variable of type object to store the folder properties.</mark>

**Outputs:**

* Expected results or responses from the action.

### **Rename**

<figure><img src="/files/x9sOmtBMR1fR4uNENsU8" alt=""><figcaption></figcaption></figure>

**Description:** Brief overview of the action's purpose.

**Purpose:** Detailed explanation of why the action is used.

**Usage:** Instructions on how to use the action.

**Inputs:**

* <mark style="color:green;">Folder Path (Required): Specify the path of the folder to be renamed.</mark>
* <mark style="color:green;">New Folder Name (Required): Specify the new name for the folder.</mark>
* <mark style="color:green;">Assign folder path to variable: Select a variable of type string to store the path of the renamed folder (optional).</mark>

**Outputs:**

* Expected results or responses from the action.

### **Unzip**

<figure><img src="/files/3Q45Nw5pU3eHgYfgUIk4" alt=""><figcaption></figcaption></figure>

**Description:** Brief overview of the action's purpose.

**Purpose:** Detailed explanation of why the action is used.

**Usage:** Instructions on how to use the action.

**Inputs:**

* <mark style="color:green;">Zip File Path (Required): Specify the path of the zip file to be extracted.</mark>
* <mark style="color:green;">Destination:</mark>
  * <mark style="color:green;">Extract to same path</mark>
  * <mark style="color:green;">Extract to given path (Required): Specify the path where the zip file will be extracted.</mark>
* <mark style="color:green;">Overwrite an existing folder: Yes or No.</mark>
* <mark style="color:green;">Assign folder path to variable: Select a variable of type string to store the path of the extracted folder (optional).</mark>

**Outputs:**

* Expected results or responses from the action.

### **Zip**

<figure><img src="/files/CSLXWPdBuqAKBPHGrxFN" alt=""><figcaption></figcaption></figure>

**Description:** Brief overview of the action's purpose.

**Purpose:** Detailed explanation of why the action is used.

**Usage:** Instructions on how to use the action.

**Inputs:**

* <mark style="color:green;">Folder Path (Required): Specify the path of the folder to be zipped.</mark>
* <mark style="color:green;">Zip Name: By default, the folder name is used.</mark>
* <mark style="color:green;">Destination:</mark>
  * <mark style="color:green;">Extract to same path</mark>
  * <mark style="color:green;">Extract to given path (Required): Specify the path where the zip file will be saved.</mark>
* <mark style="color:green;">Overwrite an existing folder: Yes or No.</mark>
* <mark style="color:green;">Assign folder path to variable: Select a variable of type string to store the path of the created zip file (optional).</mark>

**Outputs:**

* Expected results or responses from the action.

***

## Additional Tips

### [**Use Cases**](/userguide/use-cases.md)

### [FAQ](/userguide/faq.md)


---

# 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.autommate.com/userguide/libraries/transform/folder.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.
