Usage of Kulala

Kulala is a powerful API toolset that provides a comprehensive suite of features to help you develop, test, and manage your APIs efficiently.

These guides cover the .http file format as implemented by kulala-core. Examples are taken from the official http-example-files directory and cross-checked against the current parser.

Getting started

• Getting started - first requests, naming, comments
• Migration from older Kulala docs - @curl-* → @kulala-curl--*, {{ $env.VAR }}, VS Code compat

HTTP basics

• HTTP file format - request lines, versions, origin URLs
• Variables - @var, prompts, JSONPath, global headers
• Environments - http-client.env.json, Kuba, OAuth
• Magic variables - $uuid, $timestamp, $date
• Request variables - chaining named requests
• Operators and curl flags - timeouts, cookie jar, curl passthrough
• Cookies - jar behavior and @no-cookie-jar

Composition

• Import and run - import, run, variable overrides
• Shared blocks - KULALA_SHARED, KULALA_SHARED_EACH

Request and response

• Request body - file bodies, multipart, form data
• Response handling - save to file, replay

Protocols

• GraphQL
• gRPC
• WebSockets

Scripting and testing

• Scripting - JavaScript, TypeScript, and Lua
• Testing and assertions - client.test, client.assert
• Authentication - Bearer, OAuth 2.0
• Secrets managers - 1Password CLI, KeePassXC