Documentation

The httui docs are organised in four sections, depending on what you’re trying to do.

Start here

Quickstart Install httui, create a vault, run your first HTTP block. ~10 minutes.

Build a chained API test Login → capture token → hit a protected endpoint → assert. The httui workflow in one runbook.

Add a database SQLite + mutation guard + chain SQL into HTTP. No external services required.

The four sections

Tutorials

Step-by-step guides that take you from zero to a working runbook. Start here if you’re new.

• Quickstart
• Chained API test
• Add a database

How-to

Solve a specific task in 1–3 minutes.

• Use environment variables
• Store secrets in the keychain
• Reference values between blocks
• Assert response shape

Reference

Look up the exact syntax for blocks, references, and config files.

• HTTP block
• DB block
• Block references
• Vault layout
• Config files
• Shortcuts
• CLI (httui-tui)

Explanation

How httui works under the hood — architecture, performance, chat integration.

• The mental model
• Why markdown?
• Local-first
• How it works under the hood
• Architecture (deep dive)

Use httui anywhere

httui-lang The .httui block format as a real language — tree-sitter grammar + LSP server + extensions for VS Code, Neovim, Zed, and Helix.

What’s missing?

• PT-BR / ES translations — only Quickstart is partly translated. The rest falls back to English.

Want to contribute? Docs live at httuicom/httui-site — PRs welcome.