Skip to main content
The Yasumu CLI provides a powerful command-line interface for interacting with Yasumu workspaces. Use it to execute REST API requests, inspect workspace information, and automate testing workflows without opening the desktop application.

​
Use cases

The Yasumu CLI is ideal for:

​
CI/CD integration

Run API tests as part of your continuous integration pipeline: 
yasumu rest run --all --json

​
Automated testing

Execute specific REST entities or entire test suites: 
yasumu rest run "Login API" --env production

​
Workspace inspection

Quickly view workspace contents and statistics: 
yasumu info --json

​
Batch operations

Run multiple API requests sequentially with a single command: 
yasumu rest run --all --env staging --verbose

​
Available commands

The CLI provides the following commands:
  • yasumu info - Display workspace information and statistics
  • yasumu rest run - Execute REST API entities
  • yasumu rest list - List all REST entities in the workspace

​
Getting help

View available commands: 
yasumu --help
Get help for a specific command: 
yasumu rest --help
yasumu rest run --help

​
Next steps

Installation

Install the Yasumu CLI on your system

Info command

View workspace information

REST commands

Execute and manage REST entities

Build docs developers (and LLMs) love

Get started for freeTalk to us