This package lets you extend the Vicinae 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:

npm install @vicinae/api
Copy

Versioning

The @vicinae/api package follows the same versioning as the main vicinae binary, since the API is always embedded in the binary.

CLI usage

The package exports the vici 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:

npx vici --help

# assuming vicinae is running
npx vici develop

npx vici build -o my/output/path
Copy