agentme 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/speckit.analyze.agent.md +184 -0
- package/.github/agents/speckit.checklist.agent.md +295 -0
- package/.github/agents/speckit.clarify.agent.md +181 -0
- package/.github/agents/speckit.constitution.agent.md +84 -0
- package/.github/agents/speckit.implement.agent.md +198 -0
- package/.github/agents/speckit.plan.agent.md +90 -0
- package/.github/agents/speckit.specify.agent.md +237 -0
- package/.github/agents/speckit.tasks.agent.md +200 -0
- package/.github/agents/speckit.taskstoissues.agent.md +30 -0
- package/.github/prompts/speckit.analyze.prompt.md +3 -0
- package/.github/prompts/speckit.checklist.prompt.md +3 -0
- package/.github/prompts/speckit.clarify.prompt.md +3 -0
- package/.github/prompts/speckit.constitution.prompt.md +3 -0
- package/.github/prompts/speckit.implement.prompt.md +3 -0
- package/.github/prompts/speckit.plan.prompt.md +3 -0
- package/.github/prompts/speckit.specify.prompt.md +3 -0
- package/.github/prompts/speckit.tasks.prompt.md +3 -0
- package/.github/prompts/speckit.taskstoissues.prompt.md +3 -0
- package/.specify/memory/constitution.md +119 -0
- package/.specify/scripts/bash/check-prerequisites.sh +190 -0
- package/.specify/scripts/bash/common.sh +253 -0
- package/.specify/scripts/bash/create-new-feature.sh +333 -0
- package/.specify/scripts/bash/setup-plan.sh +73 -0
- package/.specify/scripts/bash/update-agent-context.sh +808 -0
- package/.specify/templates/agent-file-template.md +28 -0
- package/.specify/templates/checklist-template.md +40 -0
- package/.specify/templates/constitution-template.md +50 -0
- package/.specify/templates/plan-template.md +110 -0
- package/.specify/templates/spec-template.md +115 -0
- package/.specify/templates/tasks-template.md +251 -0
- package/.vscode/settings.json +14 -0
- package/.xdrs/agentme/edrs/application/003-javascript-project-tooling.md +89 -0
- package/.xdrs/agentme/edrs/application/010-golang-project-tooling.md +141 -0
- package/.xdrs/agentme/edrs/application/skills/001-create-javascript-project/SKILL.md +360 -0
- package/.xdrs/agentme/edrs/application/skills/003-create-golang-project/SKILL.md +311 -0
- package/.xdrs/agentme/edrs/devops/005-monorepo-structure.md +104 -0
- package/.xdrs/agentme/edrs/devops/006-github-pipelines.md +170 -0
- package/.xdrs/agentme/edrs/devops/008-common-targets.md +207 -0
- package/.xdrs/agentme/edrs/devops/skills/002-monorepo-setup/SKILL.md +270 -0
- package/.xdrs/agentme/edrs/index.md +41 -0
- package/.xdrs/agentme/edrs/observability/011-service-health-check-endpoint.md +78 -0
- package/.xdrs/agentme/edrs/principles/002-coding-best-practices.md +110 -0
- package/.xdrs/agentme/edrs/principles/004-unit-test-requirements.md +97 -0
- package/.xdrs/agentme/edrs/principles/007-project-quality-standards.md +156 -0
- package/.xdrs/agentme/edrs/principles/009-error-handling.md +327 -0
- package/.xdrs/index.md +32 -0
- package/README.md +119 -0
- package/bin/npmdata.js +3 -0
- package/package.json +102 -0
package/.xdrs/index.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# XDR Standards Index
|
|
2
|
+
|
|
3
|
+
This index points to all type- and scope-specific XDR indexes. XDRs (Decision Records) cover Architectural (ADR), Business (BDR), and Engineering (EDR) decisions. Each scope has its own canonical index that lists all XDRs for that scope, organized by subject.
|
|
4
|
+
|
|
5
|
+
## Scope Indexes
|
|
6
|
+
|
|
7
|
+
XDRs in scopes listed last override the ones listed first
|
|
8
|
+
|
|
9
|
+
### _core
|
|
10
|
+
|
|
11
|
+
Decisions about how XDRs work
|
|
12
|
+
[View general ADRs Index](_core/adrs/index.md)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
### agentme
|
|
17
|
+
|
|
18
|
+
Opiniated set of decisions and skills for common development tasks
|
|
19
|
+
|
|
20
|
+
[View agentme EDRs Index](agentme/edrs/index.md)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
### _local (reserved)
|
|
25
|
+
|
|
26
|
+
Project-local XDRs that must not be shared with other contexts. Always keep this scope last so its decisions override or extend all scopes listed above. Add specific `_local` ADR/BDR/EDR index links here when present.
|
|
27
|
+
|
|
28
|
+
[View _local BDRs Index](_local/bdrs/index.md)
|
|
29
|
+
|
|
30
|
+
[View _local ADRs Index](_local/adrs/index.md)
|
|
31
|
+
|
|
32
|
+
[View _local EDRs Index](_local/edrs/index.md)
|
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# agentme
|
|
2
|
+
|
|
3
|
+
Curated distribution package of XDRs and speckit agent workflow files for AI-assisted software development.
|
|
4
|
+
|
|
5
|
+
This collection is being updated as we develop applications and feel the need for new instructions and skills to help with AI agents.
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
This will extract all the features of agentme (skills, github configurations, speckit, xdrs collection):
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npx agentme
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If 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:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
pnpm add -D agentme
|
|
19
|
+
pnpm exec agentme extract --output . --presets basic
|
|
20
|
+
pnpm exec agentme check --output . --presets basic
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Overview
|
|
24
|
+
|
|
25
|
+
agentme is published as an npm package and consumed through `npmdata`-based extraction. It ships a curated set of reusable artifacts for other repositories:
|
|
26
|
+
|
|
27
|
+
- XDRs in `.xdrs/agentme/` for engineering, architecture, testing, tooling, and CI/CD standards.
|
|
28
|
+
- speckit agent files in `.github/`, `.specify/`, and `.vscode/` for specification-driven AI development workflows.
|
|
29
|
+
|
|
30
|
+
The package is intentionally static: consumers install it as a development dependency, extract files into their own repository, and commit the generated output.
|
|
31
|
+
|
|
32
|
+
## Presets
|
|
33
|
+
|
|
34
|
+
| Preset | Contents |
|
|
35
|
+
| --- | --- |
|
|
36
|
+
| `basic` | `xdrs-core` baseline ADRs, `AGENTS.md`, and agentme XDRs |
|
|
37
|
+
| `speckit` | speckit agents, prompts, templates, scripts, memory files, and VS Code settings |
|
|
38
|
+
| no preset | all shipped artifacts combined |
|
|
39
|
+
|
|
40
|
+
Typical consumer workflow:
|
|
41
|
+
|
|
42
|
+
1. For one-off use or a new empty folder, run `npx agentme --presets <preset>`.
|
|
43
|
+
2. For a pinned project version, add `agentme` to `package.json` and use `pnpm exec agentme ...`.
|
|
44
|
+
3. Review and commit the extracted files.
|
|
45
|
+
4. Re-run `extract` and `check` when upgrading the package.
|
|
46
|
+
|
|
47
|
+
## Usage Scenarios
|
|
48
|
+
|
|
49
|
+
### Guide AI coding with maintained ADRs and EDRs
|
|
50
|
+
|
|
51
|
+
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.
|
|
52
|
+
|
|
53
|
+
This is useful when you want agents to:
|
|
54
|
+
|
|
55
|
+
- consult explicit architecture records before choosing patterns or integrations;
|
|
56
|
+
- follow engineering rules for project structure, quality, testing, and operations;
|
|
57
|
+
- produce code that stays aligned with documented decisions instead of ad hoc prompt instructions.
|
|
58
|
+
|
|
59
|
+
### Register feature and product knowledge as BDRs
|
|
60
|
+
|
|
61
|
+
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.
|
|
62
|
+
|
|
63
|
+
This is useful when you want feature work to leave behind maintainable documentation for:
|
|
64
|
+
|
|
65
|
+
- application workflows and operating procedures;
|
|
66
|
+
- product requirements and business constraints;
|
|
67
|
+
- business decisions that explain why the feature behaves the way it does.
|
|
68
|
+
|
|
69
|
+
### Keep project documentation current through the speckit workflow
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
This is useful when you want to:
|
|
74
|
+
|
|
75
|
+
- keep the project decision log up to date as new features are specified and implemented;
|
|
76
|
+
- have architecture, engineering, and business documentation generated in a consistent XDR format;
|
|
77
|
+
- reuse the same XDR-based approach across other repositories that consume agentme.
|
|
78
|
+
|
|
79
|
+
## Development
|
|
80
|
+
|
|
81
|
+
Use the root `Makefile` as the entry point for local verification:
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
make build
|
|
85
|
+
make lint
|
|
86
|
+
make test
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
What these targets do:
|
|
90
|
+
|
|
91
|
+
- `make build` installs dependencies and creates a local npm package in `dist/`.
|
|
92
|
+
- `make lint` runs the repository lint target.
|
|
93
|
+
- `make test` rebuilds the package and validates the consumer extraction flow through the runnable example in `examples/`.
|
|
94
|
+
|
|
95
|
+
## Repository Map
|
|
96
|
+
|
|
97
|
+
```text
|
|
98
|
+
.
|
|
99
|
+
├── AGENTS.md Project instructions for AI coding agents
|
|
100
|
+
├── Makefile Root build, lint, test, and publish entry point
|
|
101
|
+
├── .mise.toml Pinned tool versions (Node.js, pnpm)
|
|
102
|
+
├── bin/ CLI entrypoint delegated to npmdata
|
|
103
|
+
├── dist/ Generated npm package tarballs
|
|
104
|
+
├── examples/ Runnable verification of consumer extraction behavior
|
|
105
|
+
├── .github/ Shipped speckit agent and prompt files
|
|
106
|
+
├── .specify/ Shipped speckit memory, scripts, and templates
|
|
107
|
+
└── .xdrs/ Shipped XDRs plus local project-only decision records
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Key folders:
|
|
111
|
+
|
|
112
|
+
- `.xdrs/_core/` contains the baseline XDR framework imported from `xdrs-core`.
|
|
113
|
+
- `.xdrs/agentme/` contains the reusable XDRs distributed to consumers.
|
|
114
|
+
- `.xdrs/_local/` contains internal decisions for this repository only and is not shipped to consumers.
|
|
115
|
+
- `examples/output/` is generated during tests to validate preset extraction and cleanup behavior.
|
|
116
|
+
|
|
117
|
+
## Release Notes
|
|
118
|
+
|
|
119
|
+
The published package exposes the `agentme` CLI through `bin/npmdata.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.
|
package/bin/npmdata.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "agentme",
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "",
|
|
5
|
+
"dependencies": {
|
|
6
|
+
"npmdata": "^0.18.14",
|
|
7
|
+
"xdrs-core": "^0.3.3"
|
|
8
|
+
},
|
|
9
|
+
"bin": "bin/npmdata.js",
|
|
10
|
+
"files": [
|
|
11
|
+
"package.json",
|
|
12
|
+
"bin/npmdata.js",
|
|
13
|
+
".xdrs/agentme/**",
|
|
14
|
+
".xdrs/index.md",
|
|
15
|
+
".github/agents/speckit*",
|
|
16
|
+
".github/prompts/speckit*",
|
|
17
|
+
".specify/**",
|
|
18
|
+
".vscode/settings.json"
|
|
19
|
+
],
|
|
20
|
+
"npmdata": {
|
|
21
|
+
"sets": [
|
|
22
|
+
{
|
|
23
|
+
"package": "xdrs-core",
|
|
24
|
+
"selector": {
|
|
25
|
+
"files": [
|
|
26
|
+
".xdrs/_core/**",
|
|
27
|
+
"AGENTS.md"
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"output": {
|
|
31
|
+
"path": ".",
|
|
32
|
+
"gitignore": false
|
|
33
|
+
},
|
|
34
|
+
"presets": [
|
|
35
|
+
"basic"
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"selector": {
|
|
40
|
+
"files": [
|
|
41
|
+
".xdrs/agentme/**"
|
|
42
|
+
]
|
|
43
|
+
},
|
|
44
|
+
"output": {
|
|
45
|
+
"path": ".",
|
|
46
|
+
"gitignore": false
|
|
47
|
+
},
|
|
48
|
+
"presets": [
|
|
49
|
+
"basic"
|
|
50
|
+
]
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"selector": {
|
|
54
|
+
"files": [
|
|
55
|
+
".xdrs/index.md"
|
|
56
|
+
]
|
|
57
|
+
},
|
|
58
|
+
"output": {
|
|
59
|
+
"path": ".",
|
|
60
|
+
"managed": false,
|
|
61
|
+
"skipIfExists": true,
|
|
62
|
+
"gitignore": false
|
|
63
|
+
},
|
|
64
|
+
"presets": [
|
|
65
|
+
"basic"
|
|
66
|
+
]
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"selector": {
|
|
70
|
+
"files": [
|
|
71
|
+
".github/agents/speckit*",
|
|
72
|
+
".github/prompts/speckit*",
|
|
73
|
+
".specify/**"
|
|
74
|
+
]
|
|
75
|
+
},
|
|
76
|
+
"output": {
|
|
77
|
+
"path": ".",
|
|
78
|
+
"gitignore": false
|
|
79
|
+
},
|
|
80
|
+
"presets": [
|
|
81
|
+
"speckit"
|
|
82
|
+
]
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"selector": {
|
|
86
|
+
"files": [
|
|
87
|
+
".vscode/settings.json"
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
"output": {
|
|
91
|
+
"path": ".",
|
|
92
|
+
"managed": false,
|
|
93
|
+
"skipIfExists": true,
|
|
94
|
+
"gitignore": false
|
|
95
|
+
},
|
|
96
|
+
"presets": [
|
|
97
|
+
"speckit"
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
]
|
|
101
|
+
}
|
|
102
|
+
}
|