Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.9 KB

File metadata and controls

37 lines (20 loc) · 1.9 KB

Reference

Lookup pages for the moving parts of APIWeave: architecture, placeholder syntax, dynamic functions, environment variables, and the typed IPC surface. Use these docs to find a name, a default, or a channel, not to learn a workflow.

Prerequisites

None. Reference docs assume you already know what you are looking for. If you are new, start at the Documentation Hub.

Architecture

  • Architecture: the components (renderer, Electron main process, IPC handler registry, repositories, runner, MCP bridge, embedded SQLite), and how a workflow run moves through them.

Placeholders and Functions

  • Placeholders: the four placeholder namespaces ({{variables}}, {{env}}, {{prev}}, {{secrets}}, function calls) and the order the runner resolves them in.
  • Dynamic Functions: the public functions you can call inside a placeholder (uuid, randomString, timestamp, randomEmail, and others), with signatures and examples.

Configuration

  • Environment Variables: every variable the app reads, grouped by feature, with defaults and what each one controls.

Releasing

  • Releases and the Update Channel: how a published release reaches installed clients, how to rehearse the update path before users run it, and the two levers for pulling a bad release back.

IPC Surface

  • IPC API: the typed IPC handler registry the renderer and the local MCP bridge call.

When to Use These Docs

Reference docs are for lookup, not how-to. If you want to build a workflow, run a project, or wire up the local MCP bridge, use the feature guides in ../features/ instead. Reach for this index when you have a specific name, default, or channel in mind and need to confirm its shape.

Related