Installation

How to get started using Vaxla into your workspace.

Easy Version

We support a configuration-less setup, we scan the directory tree to infer the best setup.

npm
pnpm
bun
yarn
npx @vaxla/cli start

Configuration

Install Vaxla CLI

npm
pnpm
bun
yarn
npm i -D @vaxla/cli

Create The Configuration File

  • apps/
  • packages/
  • vaxla/
    • config.ts
  • package.json
  • tsconfig.json
  • .gitignore
vaxla/config.ts
import { defineVaxlaConfig } from "@vaxla/cli";

export default defineVaxlaConfig({
    port: 3000,
    packages: {},
});

We support placing the configuration folder in /vaxla and /tools/vaxla by default.

If this does not satisfy your needs, you can also define the location of the configuration folder in the package.json.

package.json
{
    "name": "my-project",
    "vaxla": {
        "config": "./some-other-place/vaxla"
    }
}

Personalize

Feel free to add scripts to your configuration.

vaxla/config.ts
export default defineVaxlaConfig({
    port: 3000,
    externalLinks: {
        wiki: {
            href: 'https://example.com',
            name: 'Internal Wiki',
            icon: 'lucide:book',
        },
    },
    packages: {
        web: {
            name: "Web",
            path: "./apps/web",
            color: colors.red,
            scripts: {
                dev: {
                    command: { package: true, npm: "dev" },
                    icon: "lucide:code-xml",
                },
            },
        },
    },
});
Introduction
Vaxla provides a web UI to manage your local environment.
Configuration
How to personalize Vaxla to your workspace.