Skip to content

AI-Assisted Development

Plugboard ships with tooling to help AI coding agents understand how to build models using the framework. The plugboard ai command group provides utilities for setting up AI-assisted development workflows.

Initialising a project

The plugboard ai init command creates an AGENTS.md file in your project directory. This file gives AI coding agents the context they need to help you build Plugboard models — covering how to create components, assemble processes, use events, and follow best practices.

AGENTS.md is a convention used by AI coding tools (such as Claude Code, Codex, and Gemini CLI) to discover project-specific instructions automatically.

Usage

To create an AGENTS.md file in the current working directory:

plugboard ai init

To create the file in a specific directory:

plugboard ai init /path/to/project

Note

The command will not overwrite an existing AGENTS.md file. If one already exists in the target directory, the command exits with an error.

What's in the file?

The generated AGENTS.md covers:

  • Planning a model — how to break a problem down into components, inputs, outputs, and data flows.
  • Implementing components — using built-in library components and creating custom ones by subclassing Component.
  • Assembling a process — connecting components together and running a LocalProcess.
  • Event-driven models — defining custom Event types, emitting events, and writing event handlers.
  • Exporting models — saving process definitions to YAML and running them via the CLI.

The file is intended to be committed to version control alongside your project code so that any AI agent working in the repository has immediate access to Plugboard conventions.

Customising

After generating the file you can edit it freely to add project-specific instructions — for example, domain context, coding standards, or pointers to your own components and data sources.