Configuratie

Elke Kazzle-app heeft een kazzle.config.ts in de projectroot. Het bestand exporteert één app-definitie: hetzelfde contract dat Kazzle gebruikt voor gepubliceerde apps en ingebouwde connectors.

Snel starten

import { defineApp } from '@kazzle/app';

export default defineApp({
  schemaVersion: 1,
  name: 'My App',
  subtitle: 'A short catalog description',
  description: { type: 'markdown', path: 'README.md' },
  maxInstallations: 1,
  setup: { type: 'none' },
  launch: { type: 'component', component: 'web' },
  components: [{ name: 'web', type: 'ui', path: '.' }],
  tools: [],
  skills: [],
});

defineApp valideert de definitie en biedt TypeScript-autoaanvulling. Niet-ondersteunde of verkeerd gespelde velden mislukken validatie in plaats van genegeerd te worden.

Definitievelden

Veld	Type	Vereist	Beschrijving
`schemaVersion`	`1`	ja	Versie van het definitiecontract.
`name`	`string`	ja	Weergavenaam in de catalogus en detailpagina.
`subtitle`	`string`	ja	Eenregelige catalogusbeschrijving.
`description`	`{ type: 'markdown', path: string }`	ja	Markdown gebundeld met de app, meestal `README.md`.
`version`	`string`	nee	Uitgeversversie weergegeven met de geïnstalleerde app.
`icon`	`string`	nee	Pictogrampad relatief ten opzichte van de app-root.
`accentColor`	hex-kleur	nee	Merkaccentkleur.
`maxInstallations`	`number \| null`	ja	Maximale installaties per Space; `null` staat elk aantal toe.
`setup`	setup-object	ja	Hoe een installatie wordt geconfigureerd.
`launch`	launch-object	ja	Wat opent na installatie.
`components`	component[]	ja	UI- en procescomponenten.
`tools`	tool source[]	ja	Bronnen die compileren naar aanroepbare AI-tools.
`skills`	skill[]	ja	Instructies geladen wanneer relevant.
`kazzleAuth`	`'optional' \| 'required'`	nee	Of het startoppervlak Kazzle-identiteit vereist.
`webhookUrl`	URL	nee	Ontvangt webhooks voor installatielifecyclus.
`appLogin`	`boolean`	nee	Schakelt de eigen eindgebruikersaanmelding van de app in.

Setup

Een app kiest precies één setupstroom.

setup: { type: 'none' }

Gebruik none wanneer installatie geen externe autorisatie nodig heeft.

setup: {
  type: 'oauth',
  version: '2.0',
  metadata: {
    type: 'endpoints',
    authorizationUrl: 'https://provider.example.com/oauth/authorize',
    tokenUrl: 'https://provider.example.com/oauth/token',
  },
  scopes: ['account.read'],
  pkce: 'required',
  authorizationParams: {},
  fields: [],
}

Gebruik oauth voor OAuth 1.0a of OAuth 2.0. OAuth-clientreferenties worden privé geconfigureerd wanneer de app wordt gepubliceerd; ze verschijnen nooit in de definitie.

setup: {
  type: 'form',
  labelField: 'accountUrl',
  fields: [
    { key: 'accountUrl', label: 'Account URL', kind: 'url', required: true, secret: false },
    { key: 'apiKey', label: 'API key', kind: 'password', required: true, secret: true },
  ],
}

Formuliervelden ondersteunen text, password, url, hostname, email en select. labelField kan verwijzen naar een niet-geheim veld om meerdere installaties te onderscheiden.

Launch

launch: { type: 'none' }
launch: { type: 'component', component: 'web' }
launch: { type: 'url', url: 'https://example.com', target: 'external' }

Een componentdoel moet een component in dezelfde definitie benoemen. URL-doelen kiezen expliciet embedded of external.

Componenten

Elke component heeft een unieke name, een type van ui of process en een bron path. Een app kan maximaal één UI-component hebben.

components: [{
  name: 'server',
  type: 'process',
  path: './server',
  runtime: {
    dev: { command: 'bun run dev' },
    prod: { command: 'bun run start', build: 'bun run build' },
  },
}]

env kan een geheime verzameling en omgeving voor een component selecteren. Procescomponenten kunnen ook persistente of geactiveerde uitvoering en benoemde schema- of webhooktriggers declareren.

Tools en skills

Tools en skills zijn onafhankelijk. Tools definiëren aanroepbare bewerkingen; skills leggen uit wanneer en hoe ze te gebruiken.

tools: [
  { name: 'app-tools', type: 'file', path: './tools.ts' },
  {
    name: 'stripe',
    type: 'connection_actions',
    actions: ['customers.list', 'invoices.list'],
  },
],
skills: [
  { name: 'billing', source: { type: 'file', path: './skills/billing/SKILL.md' } },
  { name: 'review', source: { type: 'inline', instructions: 'Confirm before write actions.' } },
]

Verbindingsacties vereisen een installatie wanneer ze worden aangeroepen. Ze worden uitgegeven door Kazzle’s systeemapp-converter; gepubliceerde apps definiëren aanroepbare tools in bestanden. Skills blijven gescheiden en kunnen alleen worden geladen wanneer relevant.

Aan de slag

Bouwen

Gebruikers en gegevens

Publiceren

Kazzle gebruiken

Beveiliging

Referentie

Configuratie

Configuratie

Snel starten

Definitievelden

Setup

Launch

Componenten

Tools en skills

​Configuratie

​Snel starten

​Definitievelden

​Setup

​Launch

​Componenten

​Tools en skills

Configuratie

Snel starten

Definitievelden

Setup

Launch

Componenten

Tools en skills