Files
yaak-mountain-loop/packages/plugin-runtime-types
Gregory Schier fa3e6e6508 feat: add ctx.prompt.form() API for multi-field form dialogs
Add PromptFormRequest and PromptFormResponse types to enable plugins to
display forms with multiple input fields. Implement the form() method in
the prompt context and wire up frontend event handling to show and collect
form responses from users.
2026-01-09 19:35:47 -08:00
..
2025-01-04 16:55:18 -08:00
2025-07-02 07:47:36 -07:00

Yaak Plugin API

Yaak is a desktop API client for interacting with REST, GraphQL, Server Sent Events (SSE), WebSocket, and gRPC APIs. It's built using Tauri, Rust, and ReactJS.

Plugins can be created in TypeScript, which are executed alongside Yaak in a NodeJS runtime. This package contains the TypeScript type definitions required to make building Yaak plugins a breeze.

Quick Start

The easiest way to get started is by generating a plugin with the Yaak CLI:

npx @yaakapp/cli generate

For more details on creating plugins, check out the Quick Start Guide

Installation

If you prefer starting from scratch, manually install the types package:

npm install -D @yaakapp/api