구성

모든 Kazzle 앱은 프로젝트 루트에 kazzle.config.ts를 가지고 있습니다. 이 파일은 하나의 앱 정의를 내보냅니다. 이는 Kazzle이 게시된 앱과 기본 제공 커넥터에 사용하는 것과 동일한 계약입니다.

빠른 시작

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은 정의를 검증하고 TypeScript 자동 완성을 제공합니다. 지원되지 않거나 철자가 잘못된 필드는 무시되지 않고 검증에 실패합니다.

정의 필드

필드	타입	필수	설명
`schemaVersion`	`1`	예	정의 계약의 버전입니다.
`name`	`string`	예	카탈로그 및 상세 페이지에 표시되는 이름입니다.
`subtitle`	`string`	예	한 줄 카탈로그 설명입니다.
`description`	`{ type: 'markdown', path: string }`	예	앱과 함께 번들된 마크다운으로, 보통 `README.md`입니다.
`version`	`string`	아니오	설치된 앱과 함께 표시되는 게시자 버전입니다.
`icon`	`string`	아니오	앱 루트를 기준으로 한 아이콘 경로입니다.
`accentColor`	hex color	아니오	브랜드 강조 색상입니다.
`maxInstallations`	`number \| null`	예	스페이스당 최대 설치 수입니다. `null`은 무제한을 허용합니다.
`setup`	setup object	예	설치가 구성되는 방식입니다.
`launch`	launch object	예	설치 후 열리는 항목입니다.
`components`	component[]	예	UI 및 프로세스 컴포넌트입니다.
`tools`	tool source[]	예	호출 가능한 AI 도구로 컴파일되는 소스입니다.
`skills`	skill[]	예	관련성이 있을 때 로드되는 지침입니다.
`kazzleAuth`	`'optional' \| 'required'`	아니오	시작 표면에 Kazzle 신원이 필요한지 여부입니다.
`webhookUrl`	URL	아니오	설치 수명 주기 웹훅을 수신합니다.
`appLogin`	`boolean`	아니오	앱의 자체 최종 사용자 로그인을 활성화합니다.

설정

앱은 정확히 하나의 설정 흐름을 선택합니다.

setup: { type: 'none' }

설치에 외부 인증이 필요하지 않을 때 none을 사용합니다.

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

OAuth 1.0a 또는 OAuth 2.0에는 oauth를 사용합니다. OAuth 클라이언트 자격증명은 앱이 게시될 때 비공개로 구성되며 정의에 나타나지 않습니다.

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

폼 필드는 text, password, url, hostname, email, select를 지원합니다. labelField는 여러 설치를 구분하기 위해 비밀이 아닌 필드를 참조할 수 있습니다.

시작

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

컴포넌트 대상은 동일한 정의의 컴포넌트 이름을 지정해야 합니다. URL 대상은 embedded 또는 external을 명시적으로 선택합니다.

컴포넌트

각 컴포넌트는 고유한 name, ui 또는 process의 type, 소스 path를 가집니다. 앱은 최대 하나의 UI 컴포넌트를 가질 수 있습니다.

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

env는 컴포넌트에 대한 비밀 컬렉션과 환경을 선택할 수 있습니다. 프로세스 컴포넌트는 지속적이거나 트리거된 실행 및 명명된 일정 또는 웹훅 트리거를 선언할 수도 있습니다.

도구 및 스킬

도구와 스킬은 독립적입니다. 도구는 호출 가능한 작업을 정의하고, 스킬은 언제 어떻게 사용할지 설명합니다.

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

연결 작업은 호출될 때 설치가 필요합니다. 이들은 Kazzle의 시스템 앱 변환기에 의해 내보내지며, 게시된 앱은 파일에서 호출 가능한 도구를 정의합니다. 스킬은 별도로 유지되며 관련성이 있을 때만 로드될 수 있습니다.

시작하기

만들기

사용자와 데이터

게시

Kazzle 사용하기

보안

참조

구성

구성

빠른 시작

정의 필드

설정

시작

컴포넌트

도구 및 스킬

​구성

​빠른 시작

​정의 필드

​설정

​시작

​컴포넌트

​도구 및 스킬

구성

빠른 시작

정의 필드

설정

시작

컴포넌트

도구 및 스킬