Konfiguracja

Każda aplikacja Kazzle ma plik kazzle.config.ts w katalogu głównym projektu. Plik eksportuje jedną definicję aplikacji: ten sam kontrakt, który Kazzle wykorzystuje dla opublikowanych aplikacji i wbudowanych łączników.

Szybki start

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 waliduje definicję i zapewnia autouzupełnianie TypeScript. Nieobsługiwane lub błędnie napisane pola nie przechodzą walidacji zamiast być ignorowane.

Pola definicji

Pole	Typ	Wymagane	Opis
`schemaVersion`	`1`	tak	Wersja kontraktu definicji.
`name`	`string`	tak	Nazwa wyświetlana w katalogu i na stronie szczegółów.
`subtitle`	`string`	tak	Jednoliniowy opis w katalogu.
`description`	`{ type: 'markdown', path: string }`	tak	Markdown dołączony do aplikacji, zwykle `README.md`.
`version`	`string`	nie	Wersja wydawcy wyświetlana z zainstalowaną aplikacją.
`icon`	`string`	nie	Ścieżka ikony względem katalogu głównego aplikacji.
`accentColor`	kolor hex	nie	Kolor akcentu marki.
`maxInstallations`	`number \| null`	tak	Maksymalna liczba instalacji na Space; `null` pozwala na dowolną liczbę.
`setup`	obiekt setup	tak	Jak konfigurowana jest instalacja.
`launch`	obiekt launch	tak	Co otwiera się po instalacji.
`components`	component[]	tak	Komponenty UI i procesów.
`tools`	tool source[]	tak	Źródła, które kompilują się w wywoływalne narzędzia AI.
`skills`	skill[]	tak	Instrukcje ładowane, gdy są istotne.
`kazzleAuth`	`'optional' \| 'required'`	nie	Czy powierzchnia uruchamiania wymaga tożsamości Kazzle.
`webhookUrl`	URL	nie	Odbiera webhooki cyklu życia instalacji.
`appLogin`	`boolean`	nie	Włącza własne logowanie użytkownika końcowego aplikacji.

Setup

Aplikacja wybiera dokładnie jeden przepływ konfiguracji.

setup: { type: 'none' }

Użyj none, gdy instalacja nie wymaga zewnętrznej autoryzacji.

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

Użyj oauth dla OAuth 1.0a lub OAuth 2.0. Poświadczenia klienta OAuth są konfigurowane prywatnie, gdy aplikacja jest publikowana; nigdy nie pojawiają się w definicji.

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

Pola formularza obsługują text, password, url, hostname, email i select. labelField może odwoływać się do pola niezawierającego tajemnic, aby rozróżnić wiele instalacji.

Launch

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

Cel komponentu musi nazwać komponent w tej samej definicji. Cele URL jawnie wybierają embedded lub external.

Komponenty

Każdy komponent ma unikalną name, type równy ui lub process i źródłową path. Aplikacja może mieć co najwyżej jeden komponent UI.

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

env może wybrać kolekcję tajemnic i środowisko dla komponentu. Komponenty procesów mogą również deklarować trwałe lub wyzwalane wykonanie oraz nazwane wyzwalacze harmonogramu lub webhooka.

Narzędzia i umiejętności

Narzędzia i umiejętności są niezależne. Narzędzia definiują operacje wywoływalne; umiejętności wyjaśniają, kiedy i jak ich używać.

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

Akcje połączenia wymagają instalacji, gdy są wywoływane. Są emitowane przez konwerter aplikacji systemowej Kazzle; opublikowane aplikacje definiują wywoływalne narzędzia w plikach. Umiejętności pozostają oddzielne i mogą być ładowane tylko, gdy są istotne.

Pierwsze kroki

Budowanie

Użytkownicy i dane

Publikowanie

Korzystanie z Kazzle

Bezpieczeństwo

Materiały referencyjne

Konfiguracja

Konfiguracja

Szybki start

Pola definicji

Setup

Launch

Komponenty

Narzędzia i umiejętności

​Konfiguracja

​Szybki start

​Pola definicji

​Setup

​Launch

​Komponenty

​Narzędzia i umiejętności

Konfiguracja

Szybki start

Pola definicji

Setup

Launch

Komponenty

Narzędzia i umiejętności