Skip to main content
The Yasumu CLI is distributed as an npm package and can be installed globally or used directly with npx.

​
Prerequisites

  • Node.js 18 or higher
  • npm or pnpm package manager
  • A Yasumu workspace (created with the desktop application)

​
Global installation

Install the CLI globally to use it from anywhere: 
npm install -g yasumu
Verify the installation: 
yasumu --version

​
Using npx

Run the CLI without installing it globally: 
npx yasumu info
npx yasumu rest list
This is useful for CI/CD environments or when you want to use a specific version.

​
Workspace requirements

The CLI operates on Yasumu workspaces. A workspace is created by the Yasumu desktop application and contains:
  • yasumu/ directory with workspace files
  • workspace.ysl file with workspace metadata
  • rest/ directory with REST entity definitions
  • environment/ directory with environment configurations
By default, the CLI looks for a workspace in the current directory. Use the --path option to specify a different location: 
yasumu info --path /path/to/workspace

​
Verifying installation

Check that the CLI is working correctly: 
yasumu --help
You should see output like: 
Usage: yasumu [options] [command]

Command Line Interface for Yasumu

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  info [options]  Display information about the Yasumu workspace
  rest            REST API operations
  help [command]  display help for command

​
Next steps

CLI overview

Learn about CLI use cases and capabilities

Info command

View workspace information

REST commands

Execute REST API requests

Build docs developers (and LLMs) love

Get started for freeTalk to us