@beam-launcher/api
v1.0.0
Published
TypeScript SDK to build Beam extensions
Readme
This package lets you extend the Beam launcher using React and TypeScript.
Getting started
The recommend way to start developing a new extension is to read the docs.
The full API reference (expect breaking changes) can be found here.
Installation
Install the package:
bun add @beam-launcher/apiVersioning
The @beam-launcher/api package follows the same versioning as the main beam binary, since the API is always embedded in the binary.
CLI usage
The package exports the beam-api binary which is used to build and run extensions in development mode.
While convenience scripts are already provided in the boilerplate, you can still call the binary manually:
bunx beam-api --help
# assuming beam is running
bunx beam-api develop
bunx beam-api build -o my/output/path