Spora grows in two ways. Most operators start with a project (a customised Spora deployment with project-local code). When you have a tool worth sharing across projects, package it as a plugin.

Projects

A project is a single Spora deployment customised with project-local code. The scaffolder (spora-maker) generates the boilerplate for Tools, Controllers, and the app/App.php entry class:

• Scaffolding → make:tool, make:controller, make:app — the scaffolder command reference, with the generated-code templates and a guide for adding a new make:* command

Plugins

A Spora plugin is a Composer package that ships tools, drivers, and migrations to a Spora deployment. Authoring, install, and per-plugin reference docs:

• Plugin author guide — end-to-end guide for writing a plugin (manifest, entry-point class, tools, drivers, migrations, testing, publishing)
• Local plugin development — Composer path repositories for local dev; 3-terminal HMR walkthrough for plugins with a Vue frontend
• Install API — POST /api/v1/plugins HTTP endpoints used by the Web UI (gated by SPORA_PLUGIN_INSTALL_ENABLED); CLI is always available
• Plugin reference(Open in new window) — per-plugin reference for the 10 plugins in the Spora org (Tavily, Serper, Semantic Scholar, World News, Weather, Calendar, Email, MiniMax, Zernio, Skeleton)

Recipes are scaffolded in the codebase but not yet shipped. See Roadmap for the open work items.

Edit this page on GitHub

Contributors: Fabian Graßl

Next pageOverview