agentic-workshops
v1.4.5
Published
Install AGENTS.md and .agents/ configuration for Canonical Workshop projects
Maintainers
Readme
agentic-workshops
agentic-workshops is an npx-installable CLI that adds structured AI agent workflows to any project or set of folders, and uses Canonical Workshop for confining the AI agents. It writes AGENTS.md and a .agents/ configuration directory into the project, wiring up the Router, Architect, Implementer, and Reviewer roles, all backed by Workshop's LXD container boundary.
npx agentic-workshopsCanonical Workshop is a hard requirement. The installer reads workshop.yaml to derive the project name, available actions, and tool constraints, then interpolates them into every template it writes.
Documentation
This documentation follows the Diátaxis framework, which splits documentation into four distinct categories:
| | | |--|--| | Tutorial Set up agent workflows for a new project from scratch | How-to guides Install, update, operate the workflow, and configure editors | | Reference Command-line interface, template variables, and installed files | Explanation The four-role model, the delegation loop, and the Workshop execution boundary |
Browse the full documentation on the project wiki.
Updating
agentic-workshops runs on demand through npx and does not update itself. After each install it checks npm for a newer release and prints a notice when one is available. To update a project, re-run the latest installer:
npx agentic-workshops@latestManaged files you have not edited are refreshed to the new templates; files you changed locally are kept and flagged (the installer tracks a content hash of each file in .agents/.manifest.json). Keep customizations under .agents/local/ — never modified by the installer — so they survive updates. Pass --force to overwrite managed files regardless of local edits. After updating, run workshop refresh <project> to apply any workshop.yaml changes to the container. See Update an existing installation for the full guide.
Project, community, and contributions
agentic-workshops is an open-source project. Contributions, suggestions, and bug reports are welcome.
- Contributing guide – Workshop-based setup and development actions for contributors
- Report an issue
- Changelog
License and copyright
Copyright 2026 Rajan Patel.
The contents of this repository are licensed under the MIT License.
