Workato Platform CLI

The Workato Platform CLI is a modern, type-safe command-line interface for the Workato API, designed to help developers build, validate, and manage Workato recipes, connections, and projects.

Refer to the Workato Developer API and Embedded API for more information about the APIs you can use with the Platform CLI.

Features

The Workato Platform CLI provides the following features:

• Project management: Create, push, pull, and manage Workato projects
• Recipe operations: Validate, start, stop, and manage recipes
• Connection management: Create and manage OAuth connections
• API integration: Manage API clients, collections, and endpoints

Refer to Use cases examples for more information about these features.

Prerequisites

The Workato Platform CLI requires the following:

• Python 3.11 or later
• Valid Workato account and API token
• Network access to Workato API endpoints

Workato recommends using the CLI with a version control system, such as Git.

Authentication

The Platform CLI uses API tokens to authenticate requests.

How to generate an API token

You can generate an API token by creating an API client in Workato under Platform > API platform > Clients. Refer to configuring API clients and roles for detailed instructions.

Install the Platform CLI

Complete the following steps to install the Platform CLI:

1

Run pip install workato-platform-cli to install the CLI.

2

Run workato --version to verify your installation was successful.

Configure the Platform CLI

1

Run workato init to initialize the CLI configuration. The CLI returns a welcome message, including your workspace root.

2

Configure your profile. Enter a profile name to use a new profile, or press enter to use the default profile.

For example:

📋 Step 1: Configure profile
Enter profile name [default]:

3

Select your Workato region from the following options:

[?] Select your Workato region:
   US Data Center (https://www.workato.com)
   EU Data Center (https://app.eu.workato.com)
   JP Data Center (https://app.jp.workato.com)
   SG Data Center (https://app.sg.workato.com)
   AU Data Center (https://app.au.workato.com)
   IL Data Center (https://app.il.workato.com)
   Developer Sandbox (https://app.trial.workato.com)
 > Custom URL

4

Enter your API token. Your API token starts with wrkatrial- for trial accounts, or wrkprod- for production environments.

For example:

🔐 Enter your API token
Enter your Workato API token: wrkprod-**************
✅ Authenticated as: User Name
✅ Profile: default

5

STORE PROJECTS IN A DIRECTORY

Workato recommends creating a directory to store your projects in to maintain organization.

Select the project you plan to use with the Platform CLI. Use the project that contains the recipes or connections you plan to interact with.

For example:

📁 Step 2: Setup project
[?] Select a project:
   Create new project
   Home (ID: 75422)
   Development projects (ID: 61943)
   Sales automation project (ID: 61940)
 > Customer Onboarding (ID: 60715)

6

Enter y to proceed with initializing even though the project folder isn't empty. This adds configuration files or other setup files to your existing project. Enter N to stop initializing and prevent changes to your project folder.

⚠️  Directory '/Users/workato/Customer Onboarding' is not empty.
Proceed with initialization? This may overwrite or delete files. [y/N]: y

You see a message indicating if the initialization was successful, for example:

✅ Successfully pulled project changes (+324 -0)
🎉 Project setup complete!

7

Run workato workspace to verify your workspace is configured successfully.