Skip to content

Pre-GA Design Partner and Early Access only. Request access

Helix Docs

Reference

Exact commands, flags, configuration keys, and context APIs for Helix, organized for lookup rather than learning.

For developers
View as Markdown

The reference section states the exact surface of Helix: every CLI command and flag, every helix.config.ts key, every method on the function context, and every function signature. Come here when you know what you’re looking for and need the precise answer. For task-oriented walkthroughs, use the guides.

What lives here

CLI. Every helix command, grouped by what you’re doing: project setup and login, local development, authentications, and deploy. Each page gives the synopsis, the exact flags, and a runnable example. Start at the CLI overview.

Configuration. The helix.config.ts file: the project name, projectId, workspaceId, environment, and the authentications map your functions reference by alias. See the configuration reference.

Context API. The ctx object passed to every function: ctx.kv(), ctx.http, ctx.log, and the request members. Start at the ctx overview.

Functions. defineFunction and defineSchedule, file-based routing under functions/, and input and output schemas. See function definitions and limits.

How reference pages relate to guides

Guides walk one task from start to finish and make choices for you; reference pages enumerate everything a command or API accepts, with no narrative. The two link to each other: a guide names the commands it uses, and each reference page points back to the guide that shows the command in a real workflow. If a fact about a flag, default, or limit appears in both, the reference page is the authoritative version.

Loading search…

Jump to a section

tab to move · esc to close