---
title: "CLI Automation in Board – Command Line Tools for Board Admin & DevOps"
slug: "cli-automation"
description: "Use Board’s CLI tool to automate admin tasks: deploy ALM packages, run Procedures, manage users, snapshots, backups and environment scripting."
tags: ["System Administration", "Administrator", "CLI", "Transporter", "Platform", "PowerShell", "UNIX Shell"]
updated: 2025-10-09T14:17:13Z
published: 2025-10-09T14:17:13Z
canonical: "help.board.com/cli-automation"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.board.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI automation

This topic describes the CLI automation section, the information it provides, and how to perform an automated Data Model (Transporter) package execution.

The CLI automation section allows you to enable the Command Line Interface (CLI) Service and gives you all the necessary information and tools to create an automated and scheduled Transporter package execution via CLI.

To access the CLI automation section, open the [System Administration](/v14/docs/about-system-administration) area of the desired Platform and click on the CLI automation tile.

![contents/assets/images/cli automation.png](https://cdn.document360.io/8d6f1ae8-0cac-4d0d-a208-6245b83df94a/Images/Documentation/cli-automation-image-98skqrkx.png)

In the CLI automation page, you can see information about the CLI Service at the top of the page and how to perform an automated execution of a package below the instructions.

## Enabling the CLI service

**To enable the CLI service**, click on the "ENABLE SERVICE" button in the upper right corner. The following information is displayed:

- **Status**. This label displays the status of the CLI Service, which can be enabled or disabled.
- **Token Key**. This label displays the token key needed as a parameter in the CLI command. The token key appears only when you enable the service.

> [!NOTE]
> *Disabling the CLI service also revokes the token key. A new token key is generated every time you disable and enable the service.*
- **User**. This label displays the Account name of the user that has enabled the CLI service.
- **Created**. This label displays the date and time when the CLI service was enabled in the following format: *DD/MM/YYYY, HH:SS.*

## Execute Transporter packages from the command line

You can execute Transporter packages by using the following command-line shells:

- MS Windows Powershell
- Windows Command Line (CMD)
- Unix Shell

### Parameters

The parameters needed for the commands are listed in the table below. They are the same for all command-line shells.

| Parameter | Details |
| --- | --- |
| ```plaintext <hostname> ``` | URL of the target Platform |
| ```plaintext <token_key> ``` | Security token key that is randomly generated every time the CLI service is enabled |
| ```plaintext <package_name> ``` | Name of the Transporter package that will be executed by the script |
| ```plaintext <target_dbName> ``` | (Optional) Name of the target Data model that the Transporter package will overwrite |
| ```plaintext <snapshot_name> ``` | (Optional) Name of the new snapshot created |
| ```plaintext <snapshot_comment> ``` | (Optional) A short description related to the newly created snapshot |

> [!NOTE]
> *If you do not provide the* ***<target_datamodelName>*** *parameter, the Transporter package will automatically update the target Data model specified in the package.*

### Execute a package from the MS Windows Powershell

**To execute a package from the MS Windows Powershell**:

1. **Download the "Board-Transporter.psm1" module** by clicking on the "DOWNLOAD MODULE" and import it by following these steps:
  1. **Create a folder named "Board-Transporter"** in one of your PS module paths. To obtain the list of your PS Module Paths, use the command **$Env**:

```plaintext
PSModulePath
```

For example:

```plaintext
C:\Program Files\WindowsPowerShell\Modules\Board-Transporter
```
  2. **Copy the downloaded Board-Transporter.psm1 file** into the newly created folder named "Board-Transporter".
  3. From the MS Windows PowerShell, **run the import command**:

```plaintext
Import-Module Board-Transporter
```
2. **Enter the following command** in the MS Windows Powershell:

```plaintext
Board-Transporter -HostName "<hostname>" -Token "<token_key>" -PackageName "<package_name>" -TargetDbName "<target_dbName>"
```

### Execute a package from the Windows Command Line

**To execute a package from the Windows Command Line (CMD)**, enter the following command in the Windows CMD:

```plaintext
Curl -X POST  "<hostname>/api/AutomationManager/executeCommand" -H "board_token_type: 0" -H "board_token_auth: <token_key>" -H "content-type: application/json" -d"{\"packageName\":\"<package_name>\",\"targetDb\":\"<target_dbName>\"}"
```

### Execute a package from the Unix Shell

**To execute a package from the Unix Shell**, enter the following command in the Unix Shell:

```plaintext
Curl -X POST '<hostname>/api/AutomationManager/executeCommand' -H 'board_token_type: 0' -H 'board_token_auth: <token_key>' -H 'content-type: application/json' -d '{"packageName":"<package_name>","targetDb":"<target_dbName>"}'
```

> [!NOTE]
> *You can create script files with the commands above and schedule their execution in order to create a fully automated Transporter package execution.*

> [!NOTE]
> *Make sure the Transporter package that will be executed via CLI is located in the target Platform.*

> [!NOTE]
> *If you disable and enable the CLI service again, you must update existing scripts with the newly generated token key because disablement revokes the original token key.*