https://github.com/workato-devs/workato-platform-cli
The Workato Platform CLI
https://github.com/workato-devs/workato-platform-cli
Last synced: about 1 month ago
JSON representation
The Workato Platform CLI
- Host: GitHub
- URL: https://github.com/workato-devs/workato-platform-cli
- Owner: workato-devs
- License: mit
- Created: 2025-09-16T13:26:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-03-27T00:21:26.000Z (2 months ago)
- Last Synced: 2026-03-27T07:22:30.690Z (2 months ago)
- Language: Python
- Homepage: https://www.workato.com
- Size: 934 KB
- Stars: 19
- Watchers: 0
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.**
[](https://www.python.org/downloads/)
[](https://mypy.readthedocs.io/)
[](https://docs.astral.sh/ruff/)
[](https://opensource.org/licenses/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
1. Navigate to **Workspace Admin** → **API clients**
1. Click **Create API client**
1. Fill out information about the client, click **Create client**
1. Copy the generated token (starts with `wrkatrial-` for trial accounts or `wrkprod-` for production)
## Installation
### From PyPI (Coming Soon)
```bash
pip install workato-platform-cli
```
### From Source
```bash
git clone https://github.com/workato-devs/workato-platform-cli.git
cd workato-platform-cli
make install
```
Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting.
## Setup
```bash
# Initialize CLI (will prompt for API token and region)
workato init
# Verify your workspace
workato workspace
```
## First Commands
```bash
# List available commands
workato --help
# List your recipes
workato recipes list
# List your connections
workato connections list
# Check project status
workato workspace
```
## Next Steps
- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/COMMAND_REFERENCE.md)
- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/USE_CASES.md)
- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/examples/)
- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md)
- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/INDEX.md)
## Quick Recipe Workflow
```bash
# 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
```bash
# 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