Skip to content

feat: add plugboard ai init CLI command#237

Merged
chrisk314 merged 6 commits intomainfrom
copilot/add-cli-command-plugboard-ai-init
Mar 31, 2026
Merged

feat: add plugboard ai init CLI command#237
chrisk314 merged 6 commits intomainfrom
copilot/add-cli-command-plugboard-ai-init

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 25, 2026

Summary

Adds a new plugboard ai init CLI command that creates an AGENTS.md file in the current working directory (or a specified directory). The file provides AI coding agents with instructions for building Plugboard models, following the convention used by tools like Claude Code, Codex, and Gemini CLI.

The AGENTS.md template is kept in sync with examples/AGENTS.md via a symlink in the package.

Changes

  • plugboard/cli/ai/__init__.py — New CLI module with init command using Typer, following existing CLI patterns (rich output, stderr for errors).
  • plugboard/cli/ai/AGENTS.md — Symlink to examples/AGENTS.md so the distributed template stays in sync with the examples.
  • plugboard/cli/__init__.py — Register ai subcommand in the main CLI app.
  • tests/unit/test_cli.py — 3 new tests: successful creation, already-exists error, and default directory behavior.
  • docs/usage/ai.md — Documentation page for the new command.
  • mkdocs.yaml — Added "AI-Assisted Development" nav entry under Usage.
  • examples/AGENTS.md — Fixed two typos (componencomponent, duplicate SQLReaderSQLWriter).

Copilot AI and others added 3 commits March 25, 2026 07:51
@github-actions
Copy link
Copy Markdown

Benchmark comparison for 4ada5719 (base) vs 514de56a (PR)


------------------------------------------------------------------------------------------------------------------ benchmark: 2 tests -----------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean            StdDev              Median               IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     452.1509 (1.0)      468.6644 (1.0)      458.0943 (1.0)      6.8231 (1.06)     454.5047 (1.0)      9.5101 (1.62)          1;0  2.1830 (1.0)           5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         453.5616 (1.00)     471.3419 (1.01)     461.1464 (1.01)     6.4350 (1.0)      460.4390 (1.01)     5.8859 (1.0)           2;0  2.1685 (0.99)          5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions
Copy link
Copy Markdown

Benchmark comparison for 4ada5719 (base) vs 09417ec0 (PR)


------------------------------------------------------------------------------------------------------------------ benchmark: 2 tests -----------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean            StdDev              Median               IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         440.0163 (1.0)      445.1382 (1.0)      442.1696 (1.0)      1.9697 (1.0)      441.9111 (1.0)      2.7223 (1.0)           2;0  2.2616 (1.0)           5           1
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     450.9808 (1.02)     462.5057 (1.04)     457.3008 (1.03)     4.1594 (2.11)     458.0091 (1.04)     4.2160 (1.55)          2;0  2.1867 (0.97)          5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@github-actions
Copy link
Copy Markdown

Benchmark comparison for 4ada5719 (base) vs c1397c52 (PR)


------------------------------------------------------------------------------------------------------------------ benchmark: 2 tests -----------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean            StdDev              Median               IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     359.4430 (1.0)      367.9311 (1.01)     363.1665 (1.01)     3.4641 (2.34)     362.7974 (1.00)     5.6516 (2.25)          2;0  2.7536 (0.99)          5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         359.5688 (1.00)     362.9284 (1.0)      361.2108 (1.0)      1.4810 (1.0)      361.8413 (1.0)      2.5104 (1.0)           2;0  2.7685 (1.0)           5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@chrisk314 chrisk314 merged commit 8efdcf8 into main Mar 31, 2026
20 checks passed
@chrisk314 chrisk314 deleted the copilot/add-cli-command-plugboard-ai-init branch March 31, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants