agent-project-sdlc 0.1.6 → 0.1.7
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/README.md +76 -0
- package/package.json +2 -1
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# AI SDLC Harness
|
|
2
|
+
|
|
3
|
+
`agent-project-sdlc` provides the `sdlc-harness` CLI and canonical workflow assets for AI-assisted software delivery. It materializes an agent-readable lifecycle, workflow skills, templates, policies, gates and documentation structure into a project workspace.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -D agent-project-sdlc
|
|
9
|
+
npx sdlc-harness init
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
For existing projects:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npx sdlc-harness init --adopt
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Capabilities
|
|
19
|
+
|
|
20
|
+
| Capability | Entry Point | Description |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| Project initialization | `npx sdlc-harness init` | Creates `AGENTS.md`, `<harnessRoot>/state/**`, workflow skills, managed templates/policies, `.docs/**` and a Makefile include. |
|
|
23
|
+
| Existing project adoption | `npx sdlc-harness init --adopt` | Adds Harness non-destructively to an existing repository. |
|
|
24
|
+
| Configurable Harness root | `--harness-folder`, `package.json#sdlcHarness.harnessFolderName`, `sdlc-harness.config.json` | Supports Codex `.codex`, Claude `.claude`, Cursor `.cursor`, Cline `.cline`, Roo `.roo`, Gemini `.gemini` or a custom folder. |
|
|
25
|
+
| Managed file sync | `npx sdlc-harness sync` | Materializes package canonical assets into the configured Harness root while preserving project state, docs and local overrides. |
|
|
26
|
+
| Upgrade | `npx sdlc-harness upgrade` | Runs migrations and sync for already-adopted projects. |
|
|
27
|
+
| Diagnostics | `npx sdlc-harness doctor` | Reports Harness root, package version, schema version and key managed paths. |
|
|
28
|
+
| Validators | `npx sdlc-harness validate-*`, `make validate-current`, `make validate-harness` | Checks phase deliverables, active plan shape, prompt language contract and generated overview freshness. |
|
|
29
|
+
| Lifecycle workflow | `<harnessRoot>/state/lifecycle.yaml`, `<harnessRoot>/state/plan.yaml`, `.docs/**` | Tracks REQUIREMENT_GATHERING, ARCHITECTING, SPRINTING, REVIEWING, TESTING, RELEASING and RFC_RECALIBRATION facts. |
|
|
30
|
+
| Natural-language control | `AGENTS.md` plus workflow skills | Lets users say things like "continue", "start development", "run tests" or "requirements changed"; agents map these to workflow actions. |
|
|
31
|
+
| Workflow skills | `<harnessRoot>/skills/pjsdlc_*/SKILL.md` | Provides role prompts for product, architecture, development, implementation docs, review, testing, release and RFC recalibration. |
|
|
32
|
+
| Project-local skill overrides | `<harnessRoot>/pjsdlc_managed/override_skills/<skill_name>.md` + `npx sdlc-harness sync` | Appends project-specific role instructions to generated Skill output without editing managed Skill files. |
|
|
33
|
+
| Local policy overrides | `<harnessRoot>/pjsdlc_managed/policies/*.local.yaml` | Preserves project-specific policy additions separately from package defaults. |
|
|
34
|
+
| Documentation overview | `make docs-overview`, `make validate-doc-overviews` | Regenerates human-readable stage overviews from `.docs/**` fact slices. |
|
|
35
|
+
| Package source checks | `sdlc-harness package sync-source`, `sdlc-harness package check-source` | Maintainer commands for keeping package canonical assets aligned with this source workspace. |
|
|
36
|
+
|
|
37
|
+
## Skill Overrides
|
|
38
|
+
|
|
39
|
+
Do not edit generated files under `<harnessRoot>/skills/**/SKILL.md`; `sync` and `upgrade` regenerate them.
|
|
40
|
+
|
|
41
|
+
To customize a stage role prompt, create:
|
|
42
|
+
|
|
43
|
+
```txt
|
|
44
|
+
<harnessRoot>/pjsdlc_managed/override_skills/<skill_name>.md
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Example:
|
|
48
|
+
|
|
49
|
+
```txt
|
|
50
|
+
.codex/pjsdlc_managed/override_skills/pjsdlc_dev_sprint.md
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Then run:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npx sdlc-harness sync
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
The sync output is the package base Skill plus one appended `Local Override` block. Unknown skill names block sync so misspellings do not silently fail.
|
|
60
|
+
|
|
61
|
+
## Common Commands
|
|
62
|
+
|
|
63
|
+
```sh
|
|
64
|
+
npx sdlc-harness init
|
|
65
|
+
npx sdlc-harness init --adopt
|
|
66
|
+
npx sdlc-harness sync
|
|
67
|
+
npx sdlc-harness upgrade
|
|
68
|
+
npx sdlc-harness doctor
|
|
69
|
+
make validate-current
|
|
70
|
+
make validate-harness
|
|
71
|
+
make docs-overview
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## More Information
|
|
75
|
+
|
|
76
|
+
The source repository keeps the full product and architecture specification in `PROJECT_SPEC.md`, with implementation and release evidence under `.docs/**`.
|
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-project-sdlc",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.7",
|
|
4
4
|
"description": "CLI and canonical assets for the AI SDLC Harness workflow.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"sdlc-harness": "dist/cli.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
|
+
"README.md",
|
|
10
11
|
"dist",
|
|
11
12
|
"assets",
|
|
12
13
|
"migrations",
|