AI PLATE/ DocsBack to AI Plate
Documentation / Start here
YOUR AI PLATE HANDBOOK

Local development

Prepare the desktop checkout and find its active configuration.

Desktop source reviewed October 5, 2026

Requirements

  • Use the AI Plate desktop source checkout. package.json specifies Node.js 20 or later.
  • Run the desktop app from its project root.
  • Use a test workspace and non-sensitive fixtures when developing an extension.
From the desktop repository root
npm ci
npm run dev
shell

Configuration locations

Settings → System Configuration shows the resolved config.yaml and .env paths. The loader checks the current working directory first, then application resources and source-relative fallbacks. Do not assume the installation directory is the active configuration directory.

Custom packages live under AIPLATE_USERDATA/plugins/installed and AIPLATE_USERDATA/connectors/installed when that variable is set; otherwise the base is the process working directory. Use the app’s import UI for installed desktop builds.

Development layout
ai-plate2/
  config.yaml
  .env                      # private; never distribute
  plugins/installed/
  connectors/installed/
  plugin-sample/
  connector-sample/
text
Implementation sources

Paths in your AI Plate source checkout:

  • core/config.ts
  • core/plugin-manager.ts
  • core/connector-manager.ts

A small development loop

  • Build a minimal tool or endpoint with a JSON result.
  • Import, enable, and test it in Settings → Plugins or App Connectors.
  • Use Reload for plugins after updating local packages; re-import a connector package when its manifest changes.
  • Check a valid request, invalid arguments, service failure, and disable/re-enable behavior.
  • Package a versioned release without keys, user data, or generated node_modules.
AI Plate product & developer documentation · Static reference, no API keys collected.