mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-08-15 16:12:05 +02:00
Two problems found in review, both from deleting without checking what we actually wrote: `agent remove` called remove_dir_all on the whole tree, discarding files the user had edited or added. Install goes out of its way to preserve those, so uninstall throwing them away was inconsistent and lossy. It now deletes only tracked files whose contents still match the manifest, prunes empty directories, and reports anything it kept. `agent install` never reconciled against the previous manifest, so a file an older CLI shipped but a newer one drops would linger and could feed an agent stale guidance. Unshipped files are now removed when unmodified, and left alone (and untracked) when the user has edited them.
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:
schemasubcommands to get the JSON Schema for any model (eg.yaak request schema http)--json '{...}'input format to create and update data--verbosemode for extracting debug info while sending requests- The ability to send entire workspaces and folders (Supports
--paralleland--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)