Configuration

Chaque application Kazzle possède un fichier kazzle.config.ts à la racine du projet. Le fichier exporte une définition d’application : le même contrat que Kazzle utilise pour les applications publiées et les connecteurs intégrés.

Démarrage rapide

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 valide la définition et fournit l’autocomplétion TypeScript. Les champs non pris en charge ou mal orthographiés échouent la validation au lieu d’être ignorés.

Champs de définition

Champ	Type	Requis	Description
`schemaVersion`	`1`	oui	Version du contrat de définition.
`name`	`string`	oui	Nom d’affichage dans le catalogue et la page de détail.
`subtitle`	`string`	oui	Description du catalogue sur une ligne.
`description`	`{ type: 'markdown', path: string }`	oui	Markdown fourni avec l’application, généralement `README.md`.
`version`	`string`	non	Version de l’éditeur affichée avec l’application installée.
`icon`	`string`	non	Chemin de l’icône relatif à la racine de l’application.
`accentColor`	couleur hex	non	Couleur d’accent de la marque.
`maxInstallations`	`number \| null`	oui	Installations maximales par espace ; `null` permet n’importe quel nombre.
`setup`	objet setup	oui	Comment une installation est configurée.
`launch`	objet launch	oui	Ce qui s’ouvre après l’installation.
`components`	component[]	oui	Composants UI et processus.
`tools`	source d’outil[]	oui	Sources qui se compilent en outils IA appelables.
`skills`	skill[]	oui	Instructions chargées quand pertinent.
`kazzleAuth`	`'optional' \| 'required'`	non	Si la surface de lancement nécessite l’identité Kazzle.
`webhookUrl`	URL	non	Reçoit les webhooks du cycle de vie d’installation.
`appLogin`	`boolean`	non	Active la connexion utilisateur final propre à l’application.

Setup

Une application choisit exactement un flux de configuration.

setup: { type: 'none' }

Utilisez none quand l’installation ne nécessite aucune autorisation externe.

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: [],
}

Utilisez oauth pour OAuth 1.0a ou OAuth 2.0. Les identifiants du client OAuth sont configurés de manière privée lors de la publication de l’application ; ils n’apparaissent jamais dans la définition.

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 },
  ],
}

Les champs de formulaire supportent text, password, url, hostname, email et select. labelField peut référencer un champ non secret pour distinguer plusieurs installations.

Launch

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

Une cible de composant doit nommer un composant dans la même définition. Les cibles URL choisissent explicitement embedded ou external.

Components

Chaque composant a un name unique, un type de ui ou process, et un path source. Une application peut avoir au maximum un composant UI.

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

env peut sélectionner une collection de secrets et un environnement pour un composant. Les composants processus peuvent également déclarer une exécution persistante ou déclenchée et des déclencheurs de planification ou webhook nommés.

Tools et skills

Les outils et les compétences sont indépendants. Les outils définissent les opérations appelables ; les compétences expliquent quand et comment les utiliser.

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.' } },
]

Les actions de connexion nécessitent une installation quand elles sont appelées. Elles sont émises par le convertisseur d’application système de Kazzle ; les applications publiées définissent les outils appelables dans les fichiers. Les compétences restent séparées et ne peuvent être chargées que quand pertinent.

Démarrer

Construire

Utilisateurs et données

Publier

Utiliser Kazzle

Sécurité

Référence

Configuration

Configuration

Démarrage rapide

Champs de définition

Setup

Launch

Components

Tools et skills

​Configuration

​Démarrage rapide

​Champs de définition

​Setup

​Launch

​Components

​Tools et skills

Configuration

Démarrage rapide

Champs de définition

Setup

Launch

Components

Tools et skills