CLI and Agents

The yaak CLI allows you to publish plugins (see Plugins Quick Start) and control Yaak from the command line.

This guide focuses on using the CLI (usually paired with an AI agent line Claude or Codex) to interact with Yaak resources such as workspaces, folders, environments, and requests.

Overview

The Yaak CLI automatically detects and connects to the same local database as the installed Yaak application. Any changes made via the CLI are reflected immediately in the app.

Installation

The Yaak CLI is written in Rust, but distributed on NPM for easy installation.

npm install @yaakapp/cli

Agentic Workflow

The yaak CLI is designed to work well with AI agents and automation:

• schema subcommands to inspect JSON Schema for models (for example: yaak request schema http)
• --json '{...}' input format for creating and updating resources
• --verbose mode for extracting debug info while sending requests
• Sending entire workspaces and folders (including --parallel and --fail-fast)

Example Prompts

You can use the CLI with agents like Codex or Claude:

Scan my API routes and create a workspace (using yaak cli) with
all the requests needed for me to do manual testing.

Send all the GraphQL requests in my workspace.

---

If you were previously using the MCP Server plugin (Model Context Protocol), use the CLI for agent-driven workflows.