mirror of https://github.com/mountain-loop/yaak.git synced 2026-03-28 20:31:47 +01:00

Files

Gregory Schier 5919fae739 Run oxfmt across repo, add format script and ignore config

Format all non-generated files with oxfmt via `vp fmt`. Add
.oxfmtignore to skip bindings/ and wasm-pack output. Add npm
format script and update DEVELOPMENT.md docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-13 09:52:11 -07:00

src

Run oxfmt across repo, add format script and ignore config

2026-03-13 09:52:11 -07:00

.gitignore

Move JS monorepo packages to folder

2025-01-04 16:55:18 -08:00

package.json

Run oxfmt across repo, add format script and ignore config

2026-03-13 09:52:11 -07:00

README.md

Update feedback links

2026-01-14 06:45:45 -08:00

tsconfig.json

Fix protected branch push rejections not being detected (#345 )

2026-01-05 13:28:41 -08:00

README.md

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