mirror of https://github.com/mountain-loop/yaak.git synced 2026-08-16 08:31:57 +02:00

Files

T

Gregory Schier 314f08545c Add a Yaak CLI skill for coding agents, installed by yaak agent install

Teaches agents to drive the CLI: workspaces, environments, requests,
sending, response chaining, and importing. SKILL.md stays lean with
four references loaded on demand.

The skill is embedded in the binary and written to ~/.agents/skills plus
any detected tool directory, so it ships with the CLI and refreshes on
update. Reinstalls keep files edited locally unless --force.

Also fixes the `request schema http` hint for URL path parameters, which
said to omit the leading colon. Names without the colon are sent as query
string parameters instead, leaving the placeholder literal in the path.

2026-08-13 19:26:44 -07:00

skills/use-yaak

Add a Yaak CLI skill for coding agents, installed by yaak agent install

2026-08-13 19:26:44 -07:00

src

Add a Yaak CLI skill for coding agents, installed by yaak agent install

2026-08-13 19:26:44 -07:00

tests

Add CLI import and export commands (#484 )

2026-06-29 11:43:20 -07:00

Cargo.toml

Add CLI import and export commands (#484 )

2026-06-29 11:43:20 -07:00

README.md

Run oxfmt across repo, add format script and docs

2026-03-13 10:15:49 -07:00

README.md

Yaak CLI

The yaak CLI for publishing plugins and creating/updating/sending requests.

Installation

npm install @yaakapp/cli

Agentic Workflows

The yaak CLI is primarily meant to be used by AI agents, and has the following features:

schema subcommands to get the JSON Schema for any model (eg. yaak request schema http)
--json '{...}' input format to create and update data
--verbose mode for extracting debug info while sending requests
The ability to send entire workspaces and folders (Supports --parallel and --fail-fast)

Example Prompts

Use the yaak CLI with agents like Claude or Codex to do useful things for you.

Here are some example prompts:

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

Description

Here's the current print of yaak --help

Yaak CLI - API client from the command line

Usage: yaak [OPTIONS] <COMMAND>

Commands:
  auth         Authentication commands
  plugin       Plugin development and publishing commands
  send         Send a request, folder, or workspace by ID
  workspace    Workspace commands
  request      Request commands
  folder       Folder commands
  environment  Environment commands

Options:
      --data-dir <DATA_DIR>        Use a custom data directory
  -e, --environment <ENVIRONMENT>  Environment ID to use for variable substitution
  -v, --verbose                    Enable verbose send output (events and streamed response body)
      --log [<LEVEL>]              Enable CLI logging; optionally set level (error|warn|info|debug|trace) [possible values: error, warn, info, debug, trace]
  -h, --help                       Print help
  -V, --version                    Print version

Agent Hints:
  - Template variable syntax is ${[ my_var ]}, not {{ ... }}
  - Template function syntax is ${[ namespace.my_func(a='aaa',b='bbb') ]}
  - View JSONSchema for models before creating or updating (eg. `yaak request schema http`)
  - Deletion requires confirmation (--yes for non-interactive environments)