Installation

Note

Pilotiq is in early development. The CLI mentioned below is not yet published — these instructions track the eventual install path.

#Hosted

The fastest way to try Pilotiq is the hosted plan — sign up at pilotiq.io and connect your site.

Tip

Hosted plans get nightly builds of every plugin without managing keys yourself.

#Self-host

terminal

npm create pilotiq-app@latest

The bootstrap script scaffolds a fresh project with the panel wired up:

bootstrap/providers.ts

import { pilotiq } from '@pilotiq/pilotiq'
import { adminPanel } from '../app/Pilotiq/AdminPanel.js'

export default [
  pilotiq([adminPanel]),
]

Important

Self-host is open source. Paid plugins (agent library, AI orchestration, media library) are opt-in and work with your own API keys.

Warning

Don't commit .env files — the panel reads DATABASE_URL and provider credentials from there.

Caution

Forced overrides on the production database are irreversible. Use prisma migrate for any schema change.

#Tailwind setup

Important

Pilotiq ships Tailwind utility class names, not compiled CSS — your Tailwind build must scan the package so those classes get generated. Skip this and the panel renders unstyled (or with classes missing at random — only the ones that happen to appear elsewhere in your project survive).

Tailwind v4 — add an @source to your main CSS:

src/index.css

@import "tailwindcss";
@source "../node_modules/@pilotiq/pilotiq/dist";
@plugin "@tailwindcss/typography";   /* rich-text / markdown prose output */

Adjust the relative path so it resolves to the installed package's dist (workspace/monorepo setups can point at src).

Tailwind v3 — add it to content:

tailwind.config.js

content: ['./node_modules/@pilotiq/pilotiq/dist/**/*.js']

Tip

Adapter packages (@pilotiq/tiptap, @pilotiq/codemirror, @pilotiq/recharts) ship class names too — each needs its own @source entry pointing at its dist.