@trieungoctam/speckit 0.1.0
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 +71 -0
- package/bin/speckit +4 -0
- package/dist/adapters/antigravity-adapter.d.ts +2 -0
- package/dist/adapters/antigravity-adapter.js +41 -0
- package/dist/adapters/claude-code-adapter.d.ts +2 -0
- package/dist/adapters/claude-code-adapter.js +57 -0
- package/dist/adapters/codex-adapter.d.ts +2 -0
- package/dist/adapters/codex-adapter.js +54 -0
- package/dist/adapters/cursor-adapter.d.ts +2 -0
- package/dist/adapters/cursor-adapter.js +51 -0
- package/dist/adapters/ide-adapter.d.ts +7 -0
- package/dist/adapters/ide-adapter.js +1 -0
- package/dist/adapters/opencode-adapter.d.ts +2 -0
- package/dist/adapters/opencode-adapter.js +58 -0
- package/dist/adapters/tool-checks.d.ts +8 -0
- package/dist/adapters/tool-checks.js +28 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +104 -0
- package/dist/commands/doctor.d.ts +6 -0
- package/dist/commands/doctor.js +50 -0
- package/dist/commands/init.d.ts +7 -0
- package/dist/commands/init.js +17 -0
- package/dist/commands/next.d.ts +4 -0
- package/dist/commands/next.js +17 -0
- package/dist/commands/plan.d.ts +6 -0
- package/dist/commands/plan.js +67 -0
- package/dist/commands/quick.d.ts +6 -0
- package/dist/commands/quick.js +57 -0
- package/dist/commands/review.d.ts +5 -0
- package/dist/commands/review.js +23 -0
- package/dist/commands/run.d.ts +6 -0
- package/dist/commands/run.js +42 -0
- package/dist/commands/shape.d.ts +6 -0
- package/dist/commands/shape.js +33 -0
- package/dist/commands/sync.d.ts +5 -0
- package/dist/commands/sync.js +54 -0
- package/dist/config/adapter-registry.d.ts +5 -0
- package/dist/config/adapter-registry.js +26 -0
- package/dist/core/managed-files.d.ts +14 -0
- package/dist/core/managed-files.js +46 -0
- package/dist/core/policy.d.ts +6 -0
- package/dist/core/policy.js +65 -0
- package/dist/core/scaffold.d.ts +2 -0
- package/dist/core/scaffold.js +71 -0
- package/dist/core/slug.d.ts +2 -0
- package/dist/core/slug.js +21 -0
- package/dist/core/test-detection.d.ts +7 -0
- package/dist/core/test-detection.js +27 -0
- package/docs/adapters.md +27 -0
- package/docs/code-standards.md +9 -0
- package/docs/development-roadmap.md +30 -0
- package/docs/enterprise-rollout.md +27 -0
- package/docs/product-contract.md +27 -0
- package/docs/project-changelog.md +33 -0
- package/docs/release-checklist.md +20 -0
- package/docs/system-architecture.md +27 -0
- package/docs/workflow-model.md +49 -0
- package/package.json +51 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Development Roadmap
|
|
2
|
+
|
|
3
|
+
## Current Status
|
|
4
|
+
|
|
5
|
+
Speckit MVP is implemented and pushed to `git@github.com:trieungoctam/speckit.git` on `main`.
|
|
6
|
+
|
|
7
|
+
Current package target: `@trieungoctam/speckit@0.1.0`.
|
|
8
|
+
|
|
9
|
+
The CLI is npx-ready, generates Agile + TDD rules, creates workflow artifacts, supports five IDE adapters, wraps Beads Viewer safely, and has automated tests plus CI.
|
|
10
|
+
|
|
11
|
+
## Milestones
|
|
12
|
+
|
|
13
|
+
| Milestone | Status | Notes |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| Product contract | Complete | Contract, workflow model, and command surface documented. |
|
|
16
|
+
| CLI scaffold | Complete | `bin/speckit`, TypeScript build, command router, managed file writer. |
|
|
17
|
+
| Workflow engine | MVP Complete | `shape`, `plan`, `quick`, `run`, and `review` generate usable artifacts. |
|
|
18
|
+
| IDE adapters | Complete | Claude Code, Codex, Antigravity, OpenCode, Cursor. |
|
|
19
|
+
| Beads integration | MVP Complete | `next` wraps BV robot mode; `sync` exports story metadata JSONL. |
|
|
20
|
+
| Validation | Complete | Build and `node:test` suite pass locally. |
|
|
21
|
+
| GitHub publish | Complete | Initial code pushed to `trieungoctam/speckit` at commit `7e5c582`; status docs follow-up in progress. |
|
|
22
|
+
| npm package readiness | Ready | Package scoped as `@trieungoctam/speckit`; `npm pack --dry-run` passes. |
|
|
23
|
+
|
|
24
|
+
## Next Roadmap
|
|
25
|
+
|
|
26
|
+
- Publish `@trieungoctam/speckit` to npm.
|
|
27
|
+
- Add GitHub trusted publishing for npm releases.
|
|
28
|
+
- Add richer config loading from `.speckit/config.yaml`.
|
|
29
|
+
- Add optional direct `br`/`bd` import once command compatibility is pinned.
|
|
30
|
+
- Add snapshot tests for full adapter file contents.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Enterprise Rollout
|
|
2
|
+
|
|
3
|
+
Speckit works best as a repo-local standard, then as an organization template.
|
|
4
|
+
|
|
5
|
+
## Adoption Path
|
|
6
|
+
|
|
7
|
+
1. Pilot in one service repository with `speckit init --ide all`.
|
|
8
|
+
2. Require stories to include acceptance criteria and TDD evidence.
|
|
9
|
+
3. Add `speckit doctor` and project tests to CI.
|
|
10
|
+
4. Export stories with `speckit sync` for task graph visibility.
|
|
11
|
+
5. Roll the generated adapter pack into team templates.
|
|
12
|
+
|
|
13
|
+
## Governance Layers
|
|
14
|
+
|
|
15
|
+
| Layer | Owner | Speckit Artifact |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| Company policy | Engineering leadership | `.speckit/rules/enterprise-safety.md` |
|
|
18
|
+
| Team workflow | Tech lead | `.speckit/workflows/*.md` |
|
|
19
|
+
| Repo standard | Maintainers | `AGENTS.md`, `CLAUDE.md`, IDE config |
|
|
20
|
+
| Story evidence | Implementer | `.speckit/evidence/*.md` |
|
|
21
|
+
|
|
22
|
+
## Recommended Controls
|
|
23
|
+
|
|
24
|
+
- Do not allow code stories to merge without red-green-refactor evidence.
|
|
25
|
+
- Keep adapter output generated from Speckit instead of hand-maintaining per-IDE rules.
|
|
26
|
+
- Treat `speckit doctor` warnings as rollout debt.
|
|
27
|
+
- Use Beads Viewer only through robot commands for non-interactive automation.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Product Contract
|
|
2
|
+
|
|
3
|
+
Speckit owns the workflow contract for enterprise Agile + TDD development with agentic IDEs.
|
|
4
|
+
|
|
5
|
+
## Speckit Owns
|
|
6
|
+
|
|
7
|
+
- The `.speckit/` source of truth: config, rules, workflows, templates, generated artifacts.
|
|
8
|
+
- The command surface: `init`, `doctor`, `shape`, `plan`, `quick`, `next`, `sync`, `run`, `review`.
|
|
9
|
+
- The TDD gate: code stories require red, green, and refactor evidence.
|
|
10
|
+
- The adapter compiler for Claude Code, Codex, Antigravity, OpenCode, and Cursor.
|
|
11
|
+
- The safety policy for destructive commands, secrets, production access, and review readiness.
|
|
12
|
+
|
|
13
|
+
## Speckit Delegates
|
|
14
|
+
|
|
15
|
+
- Implementation to the selected IDE and agent runtime.
|
|
16
|
+
- Product lifecycle inspiration to BMad-style phases, without copying BMad personas or branding.
|
|
17
|
+
- Execution orchestration inspiration to ClaudeKit-style plan/cook/test/review flows.
|
|
18
|
+
- Task graph prioritization to beads and Beads Viewer robot commands.
|
|
19
|
+
- Git, tests, CI, and deployment to project-local tooling.
|
|
20
|
+
|
|
21
|
+
## State Model
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
intake -> shaped -> planned -> sliced -> spec-ready -> tests-red -> running -> tests-green -> refactor -> review-ready -> closed
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Implementation starts only after a story is spec-ready. Review starts only after test evidence exists.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Project Changelog
|
|
2
|
+
|
|
3
|
+
## 2026-05-10
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
- Created Speckit TypeScript CLI package.
|
|
8
|
+
- Scoped npm package metadata as `@trieungoctam/speckit`.
|
|
9
|
+
- Added GitHub repository metadata for `trieungoctam/speckit`.
|
|
10
|
+
- Added GitHub Actions CI for lint, test, and package dry-run checks.
|
|
11
|
+
- Added `init`, `doctor`, `shape`, `quick`, `plan`, `next`, `sync`, `run`, and `review` commands.
|
|
12
|
+
- Added managed-file generation with overwrite protection.
|
|
13
|
+
- Added native adapter generation for Claude Code, Codex, Antigravity, OpenCode, and Cursor.
|
|
14
|
+
- Added Beads Viewer-safe `next` command using robot mode only.
|
|
15
|
+
- Added story-to-JSONL sync artifact for beads integration.
|
|
16
|
+
- Added product, workflow, adapter, enterprise rollout, roadmap, and release docs.
|
|
17
|
+
- Added automated tests for adapters, managed files, init, workflow artifacts, sync, and test detection.
|
|
18
|
+
|
|
19
|
+
### Validation
|
|
20
|
+
|
|
21
|
+
- `bin/speckit init --ide all` works in a temporary directory.
|
|
22
|
+
- `npm run build` passes.
|
|
23
|
+
- `npm run lint` passes.
|
|
24
|
+
- `npm test` passes with 13 tests.
|
|
25
|
+
- `npm pack --dry-run` passes.
|
|
26
|
+
|
|
27
|
+
### Published
|
|
28
|
+
|
|
29
|
+
- Initial commit pushed to `git@github.com:trieungoctam/speckit.git` on `main`.
|
|
30
|
+
|
|
31
|
+
### Fixed
|
|
32
|
+
|
|
33
|
+
- Fixed `bin/speckit` so package binary invokes `main()` correctly when installed through npm/npx.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Release Checklist
|
|
2
|
+
|
|
3
|
+
Before publishing Speckit:
|
|
4
|
+
|
|
5
|
+
- [x] `npm run build` passes.
|
|
6
|
+
- [x] `npm run lint` passes.
|
|
7
|
+
- [x] `npm test` passes.
|
|
8
|
+
- [x] `bin/speckit init --ide all` works in a temporary directory.
|
|
9
|
+
- [x] `npm pack --dry-run` includes only package-safe files.
|
|
10
|
+
- [x] `package.json` name is `@trieungoctam/speckit` and `publishConfig.access` is `public`.
|
|
11
|
+
- [x] README uses `npx @trieungoctam/speckit@latest`.
|
|
12
|
+
- [x] Adapter output paths match `docs/adapters.md`.
|
|
13
|
+
- [x] Cursor output uses `.cursor/rules/*.mdc`, not `.cursorrules`.
|
|
14
|
+
- [x] `speckit next` only invokes `bv --robot-*`.
|
|
15
|
+
- [ ] License and attribution review is complete for ClaudeKit, BMad Method, and Beads Viewer inspiration.
|
|
16
|
+
- [x] README quickstart is accurate.
|
|
17
|
+
- [x] No secrets, local credentials, or generated private data are included.
|
|
18
|
+
- [x] Initial code pushed to `git@github.com:trieungoctam/speckit.git`.
|
|
19
|
+
- [ ] npm package published.
|
|
20
|
+
- [ ] GitHub trusted publishing configured for npm releases.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# System Architecture
|
|
2
|
+
|
|
3
|
+
```text
|
|
4
|
+
bin/speckit
|
|
5
|
+
-> dist/cli.js
|
|
6
|
+
-> src/commands/*
|
|
7
|
+
-> src/core/*
|
|
8
|
+
-> src/adapters/*
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Modules
|
|
12
|
+
|
|
13
|
+
- `src/cli.ts`: parses command line input and routes commands.
|
|
14
|
+
- `src/commands/*`: command implementations with filesystem-safe outputs.
|
|
15
|
+
- `src/core/managed-files.ts`: creates or updates only Speckit-managed files unless forced.
|
|
16
|
+
- `src/core/scaffold.ts`: defines core `.speckit/` rules, workflows, and templates.
|
|
17
|
+
- `src/core/test-detection.ts`: detects project test commands for TDD evidence.
|
|
18
|
+
- `src/adapters/*`: renders native IDE config and instruction packs.
|
|
19
|
+
- `src/adapters/tool-checks.ts`: reports external tool availability.
|
|
20
|
+
|
|
21
|
+
## Data Flow
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
user intent -> CLI command -> markdown/json artifact -> IDE adapter -> agent workflow
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The CLI does not depend on running ClaudeKit, BMad, or Beads code. External tools are optional integrations discovered at runtime.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Workflow Model
|
|
2
|
+
|
|
3
|
+
Speckit exposes two primary lanes.
|
|
4
|
+
|
|
5
|
+
## Quick Lane
|
|
6
|
+
|
|
7
|
+
Use for a bounded change.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
speckit quick "Add invoice validation"
|
|
11
|
+
speckit run .speckit/stories/<story>.md
|
|
12
|
+
speckit review
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Outputs:
|
|
16
|
+
|
|
17
|
+
- `.speckit/stories/<story>.md`
|
|
18
|
+
- `.speckit/evidence/<story>-tdd-evidence.md`
|
|
19
|
+
|
|
20
|
+
## Full Lane
|
|
21
|
+
|
|
22
|
+
Use for product or enterprise rollout work.
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
speckit shape "Standardize Agile + TDD across teams"
|
|
26
|
+
speckit plan "Standardize Agile + TDD across teams"
|
|
27
|
+
speckit sync
|
|
28
|
+
speckit next
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Outputs:
|
|
32
|
+
|
|
33
|
+
- `.speckit/specs/*.md`
|
|
34
|
+
- `.speckit/plans/<plan>/prd.md`
|
|
35
|
+
- `.speckit/plans/<plan>/architecture.md`
|
|
36
|
+
- `.speckit/plans/<plan>/story.md`
|
|
37
|
+
- `.speckit/plans/<plan>/tdd-evidence.md`
|
|
38
|
+
- `.speckit/sync/beads-sync.jsonl`
|
|
39
|
+
|
|
40
|
+
## TDD Evidence Gate
|
|
41
|
+
|
|
42
|
+
Each code story must record:
|
|
43
|
+
|
|
44
|
+
- Test intent
|
|
45
|
+
- Red command and result
|
|
46
|
+
- Green command and result
|
|
47
|
+
- Refactor command and result
|
|
48
|
+
|
|
49
|
+
Missing evidence means the story is not review-ready.
|
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@trieungoctam/speckit",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Enterprise Agile + TDD workflow compiler for agentic IDEs.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"files": [
|
|
7
|
+
"bin",
|
|
8
|
+
"dist",
|
|
9
|
+
"docs",
|
|
10
|
+
"README.md"
|
|
11
|
+
],
|
|
12
|
+
"bin": {
|
|
13
|
+
"speckit": "bin/speckit"
|
|
14
|
+
},
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+ssh://git@github.com/trieungoctam/speckit.git"
|
|
18
|
+
},
|
|
19
|
+
"bugs": {
|
|
20
|
+
"url": "https://github.com/trieungoctam/speckit/issues"
|
|
21
|
+
},
|
|
22
|
+
"homepage": "https://github.com/trieungoctam/speckit#readme",
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"access": "public"
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"build": "tsc -p tsconfig.json",
|
|
28
|
+
"test": "npm run build && node --test $(find tests -name '*.test.js' -type f | sort)",
|
|
29
|
+
"lint": "tsc -p tsconfig.json --noEmit",
|
|
30
|
+
"prepare": "npm run build",
|
|
31
|
+
"speckit": "npm run build --silent && node ./dist/cli.js"
|
|
32
|
+
},
|
|
33
|
+
"keywords": [
|
|
34
|
+
"agile",
|
|
35
|
+
"tdd",
|
|
36
|
+
"agentic-ide",
|
|
37
|
+
"claude-code",
|
|
38
|
+
"codex",
|
|
39
|
+
"cursor",
|
|
40
|
+
"opencode",
|
|
41
|
+
"antigravity"
|
|
42
|
+
],
|
|
43
|
+
"license": "MIT",
|
|
44
|
+
"engines": {
|
|
45
|
+
"node": ">=20.0.0"
|
|
46
|
+
},
|
|
47
|
+
"devDependencies": {
|
|
48
|
+
"@types/node": "^24.0.0",
|
|
49
|
+
"typescript": "^5.9.0"
|
|
50
|
+
}
|
|
51
|
+
}
|