agentme
v0.3.1
Published
Curated distribution package of XDRs and speckit agent workflow files for AI-assisted software development.
Downloads
820
Readme
agentme
Curated distribution package of XDRs and speckit agent workflow files for AI-assisted software development.
This collection is being updated as we develop applications and feel the need for new instructions and skills to help with AI agents.
For guidance on turning recurring delivery friction into reusable decision records, see Continuous XDR improvement.
Getting Started
This will extract all the features of agentme (skills, github configurations, speckit, xdrs collection):
npx agentmeIf you want the version pinned in a project, add agentme to a repository that already has a package.json and run it through the local dependency:
pnpm add -D agentme
pnpm exec agentme extract --output . --presets basic
pnpm exec agentme check --output . --presets basicOverview
agentme is published as an npm package and consumed through filedist-based extraction. It ships a curated set of reusable artifacts for other repositories:
- XDRs in
.xdrs/agentme/for engineering, architecture, testing, tooling, and CI/CD standards. - speckit agent files in
.github/,.specify/, and.vscode/for specification-driven AI development workflows.
The package is intentionally static: consumers install it as a development dependency, extract files into their own repository, and commit the generated output.
Presets
| Preset | Contents |
| --- | --- |
| basic | xdrs-core baseline ADRs, AGENTS.md, and agentme XDRs |
| speckit | speckit agents, prompts, templates, scripts, memory files, and VS Code settings |
| no preset | all shipped artifacts combined |
Typical consumer workflow:
- For one-off use or a new empty folder, run
npx agentme --presets <preset>. - For a pinned project version, add
agentmetopackage.jsonand usepnpm exec agentme .... - Review and commit the extracted files.
- Re-run
extractandcheckwhen upgrading the package.
Usage Scenarios
Guide AI coding with maintained ADRs and EDRs
Use agentme when you want architectural and engineering decisions to actively constrain how coding agents implement features. The extracted ADRs and EDRs give the repository a durable source of truth for architecture, coding practices, testing expectations, tooling, and delivery standards.
This is useful when you want agents to:
- consult explicit architecture records before choosing patterns or integrations;
- follow engineering rules for project structure, quality, testing, and operations;
- produce code that stays aligned with documented decisions instead of ad hoc prompt instructions.
Register feature and product knowledge as BDRs
Use XDR business records to capture product and operational knowledge while features are being delivered. BDRs are meant to document workflows, requirements, business rules, operating procedures, and product decisions in the same structured format as technical decisions.
This is useful when you want feature work to leave behind maintainable documentation for:
- application workflows and operating procedures;
- product requirements and business constraints;
- business decisions that explain why the feature behaves the way it does.
Keep project documentation current through the speckit workflow
Use the speckit distribution when you want the delivery workflow itself to instruct agents to maintain ADRs, EDRs, and BDRs as implementation evolves. In this model, feature development and project documentation happen together: major technical and business decisions are continuously written back into XDRs instead of being deferred to a separate documentation pass.
This is useful when you want to:
- keep the project decision log up to date as new features are specified and implemented;
- have architecture, engineering, and business documentation generated in a consistent XDR format;
- reuse the same XDR-based approach across other repositories that consume agentme.
Development
Use the root Makefile as the entry point for local verification:
make build
make lint
make testWhat these targets do:
make buildinstalls dependencies and creates a local npm package indist/.make lintruns the repository lint target.make testrebuilds the package and validates the consumer extraction flow through the runnable example inexamples/.
Repository Map
.
├── AGENTS.md Project instructions for AI coding agents
├── Makefile Root build, lint, test, and publish entry point
├── .mise.toml Pinned tool versions (Node.js, pnpm)
├── bin/ CLI entrypoint delegated to filedist
├── dist/ Generated npm package tarballs
├── examples/ Runnable verification of consumer extraction behavior
├── .github/ Shipped speckit agent and prompt files
├── .specify/ Shipped speckit memory, scripts, and templates
└── .xdrs/ Shipped XDRs plus local project-only decision recordsKey folders:
.xdrs/_core/contains the baseline XDR framework imported fromxdrs-core..xdrs/agentme/contains the reusable XDRs distributed to consumers..xdrs/_local/contains internal decisions for this repository only and is not shipped to consumers.examples/output/is generated during tests to validate preset extraction and cleanup behavior.
Release Notes
The published package exposes the agentme CLI through bin/filedist.js and is released to npm using the root publish target. The examples install the locally packed tarball from dist/ so they exercise the same package shape an external consumer receives.
