Cấu hình

Mỗi ứng dụng Kazzle có một kazzle.config.ts ở gốc dự án. Tệp này xuất một định nghĩa ứng dụng: cùng một hợp đồng mà Kazzle sử dụng cho các ứng dụng được xuất bản và các trình kết nối tích hợp.

Bắt đầu nhanh

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 xác thực định nghĩa và cung cấp tự động hoàn thành TypeScript. Các trường không được hỗ trợ hoặc bị viết sai sẽ không vượt qua xác thực thay vì bị bỏ qua.

Các trường định nghĩa

Trường	Loại	Bắt buộc	Mô tả
`schemaVersion`	`1`	có	Phiên bản của hợp đồng định nghĩa.
`name`	`string`	có	Tên hiển thị trong danh mục và trang chi tiết.
`subtitle`	`string`	có	Mô tả danh mục một dòng.
`description`	`{ type: 'markdown', path: string }`	có	Markdown được đóng gói với ứng dụng, thường là `README.md`.
`version`	`string`	không	Phiên bản nhà xuất bản được hiển thị với ứng dụng đã cài đặt.
`icon`	`string`	không	Đường dẫn biểu tượng tương đối với gốc ứng dụng.
`accentColor`	màu hex	không	Màu nhấn thương hiệu.
`maxInstallations`	`number \| null`	có	Số lần cài đặt tối đa trên mỗi Space; `null` cho phép bất kỳ số nào.
`setup`	đối tượng setup	có	Cách cài đặt được cấu hình.
`launch`	đối tượng launch	có	Những gì mở sau khi cài đặt.
`components`	component[]	có	Các thành phần UI và quy trình.
`tools`	nguồn tool[]	có	Các nguồn được biên dịch thành các công cụ AI có thể gọi được.
`skills`	skill[]	có	Các hướng dẫn được tải khi phù hợp.
`kazzleAuth`	`'optional' \| 'required'`	không	Liệu bề mặt khởi chạy có yêu cầu danh tính Kazzle hay không.
`webhookUrl`	URL	không	Nhận webhook vòng đời cài đặt.
`appLogin`	`boolean`	không	Bật đăng nhập người dùng cuối của ứng dụng.

Setup

Một ứng dụng chọn chính xác một luồng setup.

setup: { type: 'none' }

Sử dụng none khi cài đặt không cần ủy quyền bên ngoài.

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

Sử dụng oauth cho OAuth 1.0a hoặc OAuth 2.0. Thông tin xác thực máy khách OAuth được cấu hình riêng tư khi ứng dụng được xuất bản; chúng không bao giờ xuất hiện trong định nghĩa.

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

Các trường biểu mẫu hỗ trợ text, password, url, hostname, email và select. labelField có thể tham chiếu một trường không bí mật để phân biệt nhiều cài đặt.

Launch

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

Mục tiêu thành phần phải đặt tên một thành phần trong cùng một định nghĩa. Các mục tiêu URL chọn embedded hoặc external một cách rõ ràng.

Components

Mỗi thành phần có một name duy nhất, một type là ui hoặc process, và một path nguồn. Một ứng dụng có thể có tối đa một thành phần UI.

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

env có thể chọn một bộ sưu tập bí mật và môi trường cho một thành phần. Các thành phần quy trình cũng có thể khai báo thực thi liên tục hoặc được kích hoạt và các kích hoạt lịch trình hoặc webhook được đặt tên.

Tools và skills

Tools và skills là độc lập. Tools định nghĩa các hoạt động có thể gọi được; skills giải thích khi nào và cách sử dụng chúng.

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

Các hành động kết nối yêu cầu một cài đặt khi được gọi. Chúng được phát ra bởi trình chuyển đổi ứng dụng hệ thống của Kazzle; các ứng dụng được xuất bản định nghĩa các công cụ có thể gọi được trong các tệp. Skills vẫn riêng biệt và chỉ có thể được tải khi phù hợp.

Bắt đầu

Xây dựng

Người dùng và dữ liệu

Xuất bản

Sử dụng Kazzle

Bảo mật

Tham khảo

Cấu hình

Cấu hình

Bắt đầu nhanh

Các trường định nghĩa

Setup

Launch

Components

Tools và skills

​Cấu hình

​Bắt đầu nhanh

​Các trường định nghĩa

​Setup

​Launch

​Components

​Tools và skills

Cấu hình

Bắt đầu nhanh

Các trường định nghĩa

Setup

Launch

Components

Tools và skills