Developer Documentation

Developer Documentation is the home for the person operating the toolchain: running the compiler in CI, wiring up a project, reading the emitted TypeScript, and setting up an editor. It assumes you already know roughly what Bynk is and answers the operational questions instead — which command, which flag, which key in bynk.toml, what the build actually produces.

It is deliberately distinct from the language reference. To learn the language itself — what its constructs mean and how its types behave — read the Book and its Reference; the normative emission and runtime semantics live in the spec. This surface is about operating the tools that act on that language.

Command-line tools

bynkc — the compilerThe compiler invoked directly and in CI: compile, check, fmt, and test, with their flags, exit codes, and diagnostics.

bynk — the driverThe developer front-end that orchestrates the compiler and the Node toolchain: doctor, new, and dev.

Project & output

bynk.toml manifestThe project configuration file and every key it understands.

EmissionWhat TypeScript each Bynk construct compiles to, and the two build targets — bundle versus workers.

Editor & tooling

OverviewTask-focused how-tos for keeping your environment and editor working.

Check your environmentConfirm the toolchain is installed and configured correctly with bynk doctor.

Format your codeApply the canonical layout to your sources with bynk-fmt.

Set up editor supportWire up diagnostics, completion, and highlighting in your editor.

Debug in VS CodeStep through a running Bynk program from the VS Code debugger.

Tool reference

OverviewReference for the individual tools the toolchain is built from.

bynk-fmtThe formatter that enforces Bynk's canonical layout.

bynk-lspThe language server behind editor diagnostics, completion, and navigation.

tree-sitter-bynkThe grammar — the source of truth for highlighting and structural tooling.

vscode-bynkThe VS Code extension that bundles the editor experience.

API reference

Generated rustdoc for the Bynk workspace crates — the compiler internals behind the toolchain, for contributors and embedders. Most users compile Bynk through the CLIs rather than depending on these crates directly.

Crate API docsrustdoc for every workspace crate: bynkc, bynk, the compiler pipeline libraries, and the tooling crates.