Getting Started
For how the pieces fit together, see How it Works.
Installation
Node.js v22.18 or higher. Bun works too.
$ npm install vue incajs
$ npm install -D @incajs/cli$ pnpm add vue incajs
$ pnpm add -D @incajs/cli$ yarn add vue incajs
$ yarn add -D @incajs/cli$ bun add vue incajs
$ bun add -D @incajs/cliWARNING
Incarnative.js supports only ES modules.
File Structure
Scaffold your app in its own directory (e.g. ./my-app), with a package.json and a src directory:
.
├─ src
│ └─ App.vue
├─ inca.config.ts
└─ package.jsonThe directory containing package.json is the app's project root. Every path Incarnative.js resolves, including src and the dist it writes, is relative to it.
package.json needs "type": "module", satisfying the ESM-only requirement above:
{
"type": "module"
}TIP
inca build/package write their output to dist. If using Git, add it to your .gitignore file.
Source Files
Files under src are your app's source files. Incarnative.js looks for exactly one of two entry points there:
src/App.vue: no entry point or bootstrapping code needed; Incarnative.js mounts it as the app itself:vue<script setup> import { ref } from "vue"; const clicks = ref(0); </script> <template> <div :style="{ color: '#ffffff' }" @click="clicks++"> Clicked {{ clicks }} time(s) </div> </template>See Elements & Styles for every style key and what's supported.
src/main.mts, for full control over bootstrapping. It wins oversrc/App.vue. Theentrysetting lists the other file names.
Up and Running
Add an npm script like the following to package.json.
{
...
"scripts": {
"dev": "inca dev",
"build": "inca build",
"package": "inca package"
},
...
}The dev script watches your app and opens a development window that applies each edit.
$ npm run dev$ pnpm run dev$ yarn run dev$ bun --bun run devHost binary
A prebuilt binary is pulled in automatically as a platform-specific optional dependency. Neither Cargo nor Rust are needed to run an app.
| Platform | Status |
|---|---|
| Linux x64 | Limited support* |
| Linux arm64 | Limited support* |
| macOS arm64 | Supported |
| macOS x64 | Supported |
| Windows x64 | Planned |
| Windows arm64 | Planned |
* The app still needs these libraries on the machine that runs it, whether via the development window or a packaged app. inca package doesn't bundle them yet.
Linux runtime requirements
The host binary is built against glibc 2.35, so it needs Ubuntu 22.04, Debian 12, or anything newer.
On Debian/Ubuntu, it also needs:
libxcb1libfontconfig1libfreetype6libxkbcommon0libxkbcommon-x11-0libvulkan1- a Vulkan driver package, such as
mesa-vulkan-drivers
Other distributions use the same libraries under different package names. They're present by default on most desktops, but a minimal or headless install may need them added explicitly.
The list is wider than the binary needs: the binary bundles FreeType, and libfontconfig1 is linked on arm64 only.
The Vulkan loader and driver are dlopen'd at startup, so ldd does not list them. The app still needs them to render.