Skip to content

README.md

Latest commit

 

History

History
133 lines (93 loc) · 3.5 KB

README.md

File metadata and controls

133 lines (93 loc) · 3.5 KB

Workato Platform CLI

A modern, type-safe command-line interface for the Workato API, designed for automation and AI agent interaction. Perfect for AI agents helping developers build, validate, and manage Workato recipes, connections, and projects.

Python 3.11+ Type Checked Code Style License: MIT

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
  • AI Agent Support: Built-in documentation and guide system

Quick Start Guide

Get the Workato CLI running in 5 minutes.

Prerequisites

  • Python 3.11+
  • Workato account with API token

Getting Your API Token

  1. Log into your Workato account
  2. Navigate to Workspace Admin → API clients
  3. Click Create API client
  4. Fill out information about the client, click Create client
  5. Copy the generated token (starts with wrkatrial- for trial accounts or wrkprod- for production)

Installation

From PyPI (Coming Soon)

pip install workato-platform-cli

From Source

git clone https://github.com/workato-devs/workato-platform-cli.git
cd workato-platform-cli
make install

Having issues? See DEVELOPER_GUIDE.md for troubleshooting.

Setup

# Initialize CLI (will prompt for API token and region)
workato init

# Verify your workspace
workato workspace

First Commands

# List available commands
workato --help

# List your recipes
workato recipes list

# List your connections
workato connections list

# Check project status
workato workspace

Next Steps

Quick Recipe Workflow

# 1. Validate a recipe file
workato recipes validate --path ./my-recipe.json

# 2. Push changes to Workato
workato push

# 3. Pull latest from remote
workato pull

You're ready to go!

Contributing to the CLI

These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations.

For Development

# Setup (with uv - recommended)
make install-dev

# Run all checks
make check          # linting, formatting, type checking
make test          # run tests
make test-cov      # run tests with coverage

# Development workflow
make format        # auto-format code
make lint         # check code quality
make build        # build distribution packages

Tech Stack

  • 🐍 Python 3.11+ with full type annotations
  • ⚡ uv for fast dependency management
  • 🔍 mypy for static type checking
  • 🧹 ruff for linting and formatting
  • ✅ pytest for testing
  • 🔧 pre-commit for git hooks

License

MIT License