@dynamicworks/br-openspec 1.3.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/LICENSE +22 -0
- package/README.md +210 -0
- package/README.pt-BR.md +212 -0
- package/bin/openspec.js +3 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +484 -0
- package/dist/commands/change.d.ts +35 -0
- package/dist/commands/change.js +278 -0
- package/dist/commands/completion.d.ts +72 -0
- package/dist/commands/completion.js +258 -0
- package/dist/commands/config.d.ts +36 -0
- package/dist/commands/config.js +553 -0
- package/dist/commands/feedback.d.ts +9 -0
- package/dist/commands/feedback.js +184 -0
- package/dist/commands/schema.d.ts +6 -0
- package/dist/commands/schema.js +869 -0
- package/dist/commands/show.d.ts +14 -0
- package/dist/commands/show.js +133 -0
- package/dist/commands/spec.d.ts +15 -0
- package/dist/commands/spec.js +226 -0
- package/dist/commands/tools.d.ts +11 -0
- package/dist/commands/tools.js +252 -0
- package/dist/commands/validate.d.ts +24 -0
- package/dist/commands/validate.js +295 -0
- package/dist/commands/workflow/index.d.ts +17 -0
- package/dist/commands/workflow/index.js +12 -0
- package/dist/commands/workflow/instructions.d.ts +29 -0
- package/dist/commands/workflow/instructions.js +328 -0
- package/dist/commands/workflow/new-change.d.ts +11 -0
- package/dist/commands/workflow/new-change.js +44 -0
- package/dist/commands/workflow/schemas.d.ts +10 -0
- package/dist/commands/workflow/schemas.js +35 -0
- package/dist/commands/workflow/shared.d.ts +57 -0
- package/dist/commands/workflow/shared.js +117 -0
- package/dist/commands/workflow/status.d.ts +14 -0
- package/dist/commands/workflow/status.js +76 -0
- package/dist/commands/workflow/templates.d.ts +16 -0
- package/dist/commands/workflow/templates.js +70 -0
- package/dist/core/archive.d.ts +11 -0
- package/dist/core/archive.js +322 -0
- package/dist/core/artifact-graph/graph.d.ts +56 -0
- package/dist/core/artifact-graph/graph.js +141 -0
- package/dist/core/artifact-graph/index.d.ts +8 -0
- package/dist/core/artifact-graph/index.js +14 -0
- package/dist/core/artifact-graph/instruction-loader.d.ts +143 -0
- package/dist/core/artifact-graph/instruction-loader.js +217 -0
- package/dist/core/artifact-graph/outputs.d.ts +14 -0
- package/dist/core/artifact-graph/outputs.js +39 -0
- package/dist/core/artifact-graph/resolver.d.ts +81 -0
- package/dist/core/artifact-graph/resolver.js +258 -0
- package/dist/core/artifact-graph/schema.d.ts +13 -0
- package/dist/core/artifact-graph/schema.js +108 -0
- package/dist/core/artifact-graph/state.d.ts +12 -0
- package/dist/core/artifact-graph/state.js +31 -0
- package/dist/core/artifact-graph/types.d.ts +45 -0
- package/dist/core/artifact-graph/types.js +43 -0
- package/dist/core/available-tools.d.ts +17 -0
- package/dist/core/available-tools.js +43 -0
- package/dist/core/command-generation/adapters/amazon-q.d.ts +13 -0
- package/dist/core/command-generation/adapters/amazon-q.js +26 -0
- package/dist/core/command-generation/adapters/antigravity.d.ts +13 -0
- package/dist/core/command-generation/adapters/antigravity.js +26 -0
- package/dist/core/command-generation/adapters/auggie.d.ts +13 -0
- package/dist/core/command-generation/adapters/auggie.js +27 -0
- package/dist/core/command-generation/adapters/bob.d.ts +14 -0
- package/dist/core/command-generation/adapters/bob.js +45 -0
- package/dist/core/command-generation/adapters/claude.d.ts +13 -0
- package/dist/core/command-generation/adapters/claude.js +50 -0
- package/dist/core/command-generation/adapters/cline.d.ts +14 -0
- package/dist/core/command-generation/adapters/cline.js +27 -0
- package/dist/core/command-generation/adapters/codebuddy.d.ts +13 -0
- package/dist/core/command-generation/adapters/codebuddy.js +28 -0
- package/dist/core/command-generation/adapters/codex.d.ts +16 -0
- package/dist/core/command-generation/adapters/codex.js +39 -0
- package/dist/core/command-generation/adapters/continue.d.ts +13 -0
- package/dist/core/command-generation/adapters/continue.js +28 -0
- package/dist/core/command-generation/adapters/costrict.d.ts +13 -0
- package/dist/core/command-generation/adapters/costrict.js +27 -0
- package/dist/core/command-generation/adapters/crush.d.ts +13 -0
- package/dist/core/command-generation/adapters/crush.js +30 -0
- package/dist/core/command-generation/adapters/cursor.d.ts +14 -0
- package/dist/core/command-generation/adapters/cursor.js +44 -0
- package/dist/core/command-generation/adapters/factory.d.ts +13 -0
- package/dist/core/command-generation/adapters/factory.js +27 -0
- package/dist/core/command-generation/adapters/gemini.d.ts +13 -0
- package/dist/core/command-generation/adapters/gemini.js +26 -0
- package/dist/core/command-generation/adapters/github-copilot.d.ts +13 -0
- package/dist/core/command-generation/adapters/github-copilot.js +26 -0
- package/dist/core/command-generation/adapters/iflow.d.ts +13 -0
- package/dist/core/command-generation/adapters/iflow.js +29 -0
- package/dist/core/command-generation/adapters/index.d.ts +32 -0
- package/dist/core/command-generation/adapters/index.js +32 -0
- package/dist/core/command-generation/adapters/junie.d.ts +13 -0
- package/dist/core/command-generation/adapters/junie.js +26 -0
- package/dist/core/command-generation/adapters/kilocode.d.ts +14 -0
- package/dist/core/command-generation/adapters/kilocode.js +23 -0
- package/dist/core/command-generation/adapters/kiro.d.ts +13 -0
- package/dist/core/command-generation/adapters/kiro.js +26 -0
- package/dist/core/command-generation/adapters/lingma.d.ts +13 -0
- package/dist/core/command-generation/adapters/lingma.js +30 -0
- package/dist/core/command-generation/adapters/opencode.d.ts +13 -0
- package/dist/core/command-generation/adapters/opencode.js +29 -0
- package/dist/core/command-generation/adapters/pi.d.ts +18 -0
- package/dist/core/command-generation/adapters/pi.js +55 -0
- package/dist/core/command-generation/adapters/qoder.d.ts +13 -0
- package/dist/core/command-generation/adapters/qoder.js +30 -0
- package/dist/core/command-generation/adapters/qwen.d.ts +13 -0
- package/dist/core/command-generation/adapters/qwen.js +26 -0
- package/dist/core/command-generation/adapters/roocode.d.ts +14 -0
- package/dist/core/command-generation/adapters/roocode.js +27 -0
- package/dist/core/command-generation/adapters/windsurf.d.ts +14 -0
- package/dist/core/command-generation/adapters/windsurf.js +51 -0
- package/dist/core/command-generation/generator.d.ts +21 -0
- package/dist/core/command-generation/generator.js +27 -0
- package/dist/core/command-generation/index.d.ts +22 -0
- package/dist/core/command-generation/index.js +24 -0
- package/dist/core/command-generation/registry.d.ts +36 -0
- package/dist/core/command-generation/registry.js +98 -0
- package/dist/core/command-generation/types.d.ts +56 -0
- package/dist/core/command-generation/types.js +8 -0
- package/dist/core/completions/command-registry.d.ts +7 -0
- package/dist/core/completions/command-registry.js +462 -0
- package/dist/core/completions/completion-provider.d.ts +60 -0
- package/dist/core/completions/completion-provider.js +102 -0
- package/dist/core/completions/factory.d.ts +64 -0
- package/dist/core/completions/factory.js +75 -0
- package/dist/core/completions/generators/bash-generator.d.ts +32 -0
- package/dist/core/completions/generators/bash-generator.js +174 -0
- package/dist/core/completions/generators/fish-generator.d.ts +32 -0
- package/dist/core/completions/generators/fish-generator.js +157 -0
- package/dist/core/completions/generators/powershell-generator.d.ts +33 -0
- package/dist/core/completions/generators/powershell-generator.js +208 -0
- package/dist/core/completions/generators/zsh-generator.d.ts +44 -0
- package/dist/core/completions/generators/zsh-generator.js +250 -0
- package/dist/core/completions/installers/bash-installer.d.ts +87 -0
- package/dist/core/completions/installers/bash-installer.js +319 -0
- package/dist/core/completions/installers/fish-installer.d.ts +43 -0
- package/dist/core/completions/installers/fish-installer.js +143 -0
- package/dist/core/completions/installers/powershell-installer.d.ts +102 -0
- package/dist/core/completions/installers/powershell-installer.js +400 -0
- package/dist/core/completions/installers/zsh-installer.d.ts +125 -0
- package/dist/core/completions/installers/zsh-installer.js +450 -0
- package/dist/core/completions/templates/bash-templates.d.ts +6 -0
- package/dist/core/completions/templates/bash-templates.js +24 -0
- package/dist/core/completions/templates/fish-templates.d.ts +7 -0
- package/dist/core/completions/templates/fish-templates.js +39 -0
- package/dist/core/completions/templates/powershell-templates.d.ts +6 -0
- package/dist/core/completions/templates/powershell-templates.js +25 -0
- package/dist/core/completions/templates/zsh-templates.d.ts +6 -0
- package/dist/core/completions/templates/zsh-templates.js +36 -0
- package/dist/core/completions/types.d.ts +79 -0
- package/dist/core/completions/types.js +2 -0
- package/dist/core/config-prompts.d.ts +9 -0
- package/dist/core/config-prompts.js +34 -0
- package/dist/core/config-schema.d.ts +86 -0
- package/dist/core/config-schema.js +213 -0
- package/dist/core/config.d.ts +18 -0
- package/dist/core/config.js +38 -0
- package/dist/core/converters/json-converter.d.ts +6 -0
- package/dist/core/converters/json-converter.js +51 -0
- package/dist/core/global-config.d.ts +44 -0
- package/dist/core/global-config.js +125 -0
- package/dist/core/index.d.ts +2 -0
- package/dist/core/index.js +3 -0
- package/dist/core/init.d.ts +37 -0
- package/dist/core/init.js +549 -0
- package/dist/core/is-project-initialized.d.ts +12 -0
- package/dist/core/is-project-initialized.js +18 -0
- package/dist/core/legacy-cleanup.d.ts +162 -0
- package/dist/core/legacy-cleanup.js +515 -0
- package/dist/core/list.d.ts +9 -0
- package/dist/core/list.js +172 -0
- package/dist/core/migration.d.ts +23 -0
- package/dist/core/migration.js +109 -0
- package/dist/core/parsers/change-parser.d.ts +13 -0
- package/dist/core/parsers/change-parser.js +197 -0
- package/dist/core/parsers/markdown-parser.d.ts +26 -0
- package/dist/core/parsers/markdown-parser.js +228 -0
- package/dist/core/parsers/requirement-blocks.d.ts +37 -0
- package/dist/core/parsers/requirement-blocks.js +201 -0
- package/dist/core/parsers/spec-structure.d.ts +9 -0
- package/dist/core/parsers/spec-structure.js +88 -0
- package/dist/core/profile-sync-drift.d.ts +38 -0
- package/dist/core/profile-sync-drift.js +200 -0
- package/dist/core/profiles.d.ts +26 -0
- package/dist/core/profiles.js +40 -0
- package/dist/core/project-config.d.ts +64 -0
- package/dist/core/project-config.js +224 -0
- package/dist/core/schemas/base.schema.d.ts +13 -0
- package/dist/core/schemas/base.schema.js +13 -0
- package/dist/core/schemas/change.schema.d.ts +73 -0
- package/dist/core/schemas/change.schema.js +31 -0
- package/dist/core/schemas/index.d.ts +4 -0
- package/dist/core/schemas/index.js +4 -0
- package/dist/core/schemas/spec.schema.d.ts +18 -0
- package/dist/core/schemas/spec.schema.js +15 -0
- package/dist/core/shared/index.d.ts +8 -0
- package/dist/core/shared/index.js +8 -0
- package/dist/core/shared/skill-generation.d.ts +49 -0
- package/dist/core/shared/skill-generation.js +96 -0
- package/dist/core/shared/tool-detection.d.ts +71 -0
- package/dist/core/shared/tool-detection.js +158 -0
- package/dist/core/specs-apply.d.ts +73 -0
- package/dist/core/specs-apply.js +393 -0
- package/dist/core/styles/palette.d.ts +7 -0
- package/dist/core/styles/palette.js +8 -0
- package/dist/core/templates/index.d.ts +8 -0
- package/dist/core/templates/index.js +9 -0
- package/dist/core/templates/skill-templates.d.ts +20 -0
- package/dist/core/templates/skill-templates.js +19 -0
- package/dist/core/templates/types.d.ts +19 -0
- package/dist/core/templates/types.js +5 -0
- package/dist/core/templates/workflows/apply-change.d.ts +10 -0
- package/dist/core/templates/workflows/apply-change.js +308 -0
- package/dist/core/templates/workflows/archive-change.d.ts +10 -0
- package/dist/core/templates/workflows/archive-change.js +271 -0
- package/dist/core/templates/workflows/bulk-archive-change.d.ts +10 -0
- package/dist/core/templates/workflows/bulk-archive-change.js +492 -0
- package/dist/core/templates/workflows/continue-change.d.ts +10 -0
- package/dist/core/templates/workflows/continue-change.js +232 -0
- package/dist/core/templates/workflows/explore.d.ts +10 -0
- package/dist/core/templates/workflows/explore.js +463 -0
- package/dist/core/templates/workflows/feedback.d.ts +9 -0
- package/dist/core/templates/workflows/feedback.js +108 -0
- package/dist/core/templates/workflows/ff-change.d.ts +10 -0
- package/dist/core/templates/workflows/ff-change.js +198 -0
- package/dist/core/templates/workflows/new-change.d.ts +10 -0
- package/dist/core/templates/workflows/new-change.js +21 -0
- package/dist/core/templates/workflows/onboard.d.ts +10 -0
- package/dist/core/templates/workflows/onboard.js +21 -0
- package/dist/core/templates/workflows/propose.d.ts +10 -0
- package/dist/core/templates/workflows/propose.js +216 -0
- package/dist/core/templates/workflows/sync-specs.d.ts +10 -0
- package/dist/core/templates/workflows/sync-specs.js +272 -0
- package/dist/core/templates/workflows/upstream-sync.d.ts +10 -0
- package/dist/core/templates/workflows/upstream-sync.js +116 -0
- package/dist/core/templates/workflows/verify-change.d.ts +10 -0
- package/dist/core/templates/workflows/verify-change.js +21 -0
- package/dist/core/tools-manager.d.ts +56 -0
- package/dist/core/tools-manager.js +215 -0
- package/dist/core/update.d.ts +77 -0
- package/dist/core/update.js +538 -0
- package/dist/core/validation/constants.d.ts +34 -0
- package/dist/core/validation/constants.js +40 -0
- package/dist/core/validation/types.d.ts +18 -0
- package/dist/core/validation/types.js +2 -0
- package/dist/core/validation/validator.d.ts +33 -0
- package/dist/core/validation/validator.js +419 -0
- package/dist/core/view.d.ts +8 -0
- package/dist/core/view.js +169 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/messages/index.d.ts +867 -0
- package/dist/messages/index.js +1960 -0
- package/dist/prompts/searchable-multi-select.d.ts +28 -0
- package/dist/prompts/searchable-multi-select.js +160 -0
- package/dist/telemetry/config.d.ts +38 -0
- package/dist/telemetry/config.js +136 -0
- package/dist/telemetry/index.d.ts +31 -0
- package/dist/telemetry/index.js +165 -0
- package/dist/ui/ascii-patterns.d.ts +16 -0
- package/dist/ui/ascii-patterns.js +133 -0
- package/dist/ui/welcome-screen.d.ts +10 -0
- package/dist/ui/welcome-screen.js +147 -0
- package/dist/utils/change-metadata.d.ts +51 -0
- package/dist/utils/change-metadata.js +147 -0
- package/dist/utils/change-utils.d.ts +62 -0
- package/dist/utils/change-utils.js +121 -0
- package/dist/utils/command-references.d.ts +18 -0
- package/dist/utils/command-references.js +20 -0
- package/dist/utils/file-system.d.ts +41 -0
- package/dist/utils/file-system.js +302 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.js +9 -0
- package/dist/utils/interactive.d.ts +18 -0
- package/dist/utils/interactive.js +21 -0
- package/dist/utils/item-discovery.d.ts +4 -0
- package/dist/utils/item-discovery.js +72 -0
- package/dist/utils/match.d.ts +3 -0
- package/dist/utils/match.js +22 -0
- package/dist/utils/shell-detection.d.ts +20 -0
- package/dist/utils/shell-detection.js +41 -0
- package/dist/utils/task-progress.d.ts +8 -0
- package/dist/utils/task-progress.js +37 -0
- package/package.json +84 -0
- package/schemas/spec-driven/schema.yaml +153 -0
- package/schemas/spec-driven/templates/design.md +19 -0
- package/schemas/spec-driven/templates/proposal.md +23 -0
- package/schemas/spec-driven/templates/spec.md +8 -0
- package/schemas/spec-driven/templates/tasks.md +9 -0
- package/scripts/postinstall.js +83 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 BR-OpenSpec Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/dynamicworks-com-br/BR-OpenSpec">
|
|
3
|
+
<picture>
|
|
4
|
+
<source srcset="assets/openspec_bg.png">
|
|
5
|
+
<img src="assets/openspec_bg.png" alt="OpenSpec logo">
|
|
6
|
+
</picture>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<a href="https://github.com/dynamicworks-com-br/BR-OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/dynamicworks-com-br/BR-OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
|
|
12
|
+
<a href="https://www.npmjs.com/package/@dynamicworks/br-openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@dynamicworks/br-openspec?style=flat-square" /></a>
|
|
13
|
+
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
<details>
|
|
17
|
+
<summary><strong>The most loved spec framework.</strong></summary>
|
|
18
|
+
|
|
19
|
+
[](https://github.com/dynamicworks-com-br/BR-OpenSpec/stargazers)
|
|
20
|
+
[](https://www.npmjs.com/package/@dynamicworks/br-openspec)
|
|
21
|
+
[](https://github.com/dynamicworks-com-br/BR-OpenSpec/graphs/contributors)
|
|
22
|
+
|
|
23
|
+
</details>
|
|
24
|
+
<p></p>
|
|
25
|
+
Our philosophy:
|
|
26
|
+
|
|
27
|
+
> This philosophy was defined by the original [OpenSpec](https://github.com/tab-tools/openspec) project and BR-OpenSpec will do its best to honor it in every decision.
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
→ fluid not rigid
|
|
31
|
+
→ iterative not waterfall
|
|
32
|
+
→ easy not complex
|
|
33
|
+
→ built for brownfield not just greenfield
|
|
34
|
+
→ scalable from personal projects to enterprises
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
> [!TIP]
|
|
38
|
+
> **New workflow now available!** We've rebuilt BR-OpenSpec with a new artifact-guided workflow.
|
|
39
|
+
>
|
|
40
|
+
> Run `/opsx:propose "your idea"` to get started. → [Learn more here](docs/opsx.md)
|
|
41
|
+
|
|
42
|
+
<p align="center">
|
|
43
|
+
Follow <a href="https://x.com/0xTab">@0xTab on X</a> for updates.
|
|
44
|
+
</p>
|
|
45
|
+
|
|
46
|
+
<!-- TODO: Add GIF demo of /opsx:propose → /opsx:archive workflow -->
|
|
47
|
+
|
|
48
|
+
## See it in action
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
You: /opsx:propose add-dark-mode
|
|
52
|
+
AI: Created openspec/changes/add-dark-mode/
|
|
53
|
+
✓ proposal.md — why we're doing this, what's changing
|
|
54
|
+
✓ specs/ — requirements and scenarios
|
|
55
|
+
✓ design.md — technical approach
|
|
56
|
+
✓ tasks.md — implementation checklist
|
|
57
|
+
Ready for implementation!
|
|
58
|
+
|
|
59
|
+
You: /opsx:apply
|
|
60
|
+
AI: Implementing tasks...
|
|
61
|
+
✓ 1.1 Add theme context provider
|
|
62
|
+
✓ 1.2 Create toggle component
|
|
63
|
+
✓ 2.1 Add CSS variables
|
|
64
|
+
✓ 2.2 Wire up localStorage
|
|
65
|
+
All tasks complete!
|
|
66
|
+
|
|
67
|
+
You: /opsx:archive
|
|
68
|
+
AI: Archived to openspec/changes/archive/2025-01-23-add-dark-mode/
|
|
69
|
+
Specs updated. Ready for the next feature.
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
<details>
|
|
73
|
+
<summary><strong>BR-OpenSpec Dashboard</strong></summary>
|
|
74
|
+
|
|
75
|
+
<p align="center">
|
|
76
|
+
<img src="assets/openspec_dashboard.png" alt="OpenSpec dashboard preview" width="90%">
|
|
77
|
+
</p>
|
|
78
|
+
|
|
79
|
+
</details>
|
|
80
|
+
|
|
81
|
+
## Quick Start
|
|
82
|
+
|
|
83
|
+
**Requires Node.js 20.19.0 or higher.**
|
|
84
|
+
|
|
85
|
+
Install BR-OpenSpec globally:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npm install -g @dynamicworks/br-openspec@latest
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Then navigate to your project directory and initialize:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
cd your-project
|
|
95
|
+
openspec init
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Now tell your AI: `/opsx:propose <what-you-want-to-build>`
|
|
99
|
+
|
|
100
|
+
If you want the expanded workflow (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:sync`, `/opsx:bulk-archive`, `/opsx:onboard`), select it with `openspec config profile` and apply with `openspec update`.
|
|
101
|
+
|
|
102
|
+
> [!NOTE]
|
|
103
|
+
> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 25+ tools and growing.
|
|
104
|
+
>
|
|
105
|
+
> Also works with pnpm, yarn, bun, and nix. [See installation options](docs/installation.md).
|
|
106
|
+
|
|
107
|
+
## Docs
|
|
108
|
+
|
|
109
|
+
→ **[Getting Started](docs/getting-started.md)**: first steps<br>
|
|
110
|
+
→ **[Workflows](docs/workflows.md)**: combos and patterns<br>
|
|
111
|
+
→ **[Commands](docs/commands.md)**: slash commands & skills<br>
|
|
112
|
+
→ **[CLI](docs/cli.md)**: terminal reference<br>
|
|
113
|
+
→ **[Supported Tools](docs/supported-tools.md)**: tool integrations & install paths<br>
|
|
114
|
+
→ **[Concepts](docs/concepts.md)**: how it all fits<br>
|
|
115
|
+
→ **[Multi-Language](docs/multi-language.md)**: multi-language support<br>
|
|
116
|
+
→ **[Customization](docs/customization.md)**: make it yours
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
## Why BR-OpenSpec?
|
|
120
|
+
|
|
121
|
+
AI coding assistants are powerful but unpredictable when requirements live only in chat history. BR-OpenSpec adds a lightweight spec layer so you agree on what to build before any code is written.
|
|
122
|
+
|
|
123
|
+
- **Agree before you build** — human and AI align on specs before code gets written
|
|
124
|
+
- **Stay organized** — each change gets its own folder with proposal, specs, design, and tasks
|
|
125
|
+
- **Work fluidly** — update any artifact anytime, no rigid phase gates
|
|
126
|
+
- **Use your tools** — works with 20+ AI assistants via slash commands
|
|
127
|
+
|
|
128
|
+
### How we compare
|
|
129
|
+
|
|
130
|
+
**vs. [Spec Kit](https://github.com/github/spec-kit)** (GitHub) — Thorough but heavyweight. Rigid phase gates, lots of Markdown, Python setup. BR-OpenSpec is lighter and lets you iterate freely.
|
|
131
|
+
|
|
132
|
+
**vs. [Kiro](https://kiro.dev)** (AWS) — Powerful but you're locked into their IDE and limited to Claude models. BR-OpenSpec works with the tools you already use.
|
|
133
|
+
|
|
134
|
+
**vs. nothing** — AI coding without specs means vague prompts and unpredictable results. BR-OpenSpec brings predictability without the ceremony.
|
|
135
|
+
|
|
136
|
+
## Updating BR-OpenSpec
|
|
137
|
+
|
|
138
|
+
**Upgrade the package**
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
npm install -g @dynamicworks/br-openspec@latest
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**Refresh agent instructions**
|
|
145
|
+
|
|
146
|
+
Run this inside each project to regenerate AI guidance and ensure the latest slash commands are active:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
openspec update
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
**Manage IDE/Code Agent configurations**
|
|
153
|
+
|
|
154
|
+
Add or remove supported IDE and Code Agent integrations without re-running `init`:
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
openspec tools # interactive checklist
|
|
158
|
+
openspec tools --add claude,cursor
|
|
159
|
+
openspec tools --remove windsurf
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Usage Notes
|
|
163
|
+
|
|
164
|
+
**Model selection**: BR-OpenSpec works best with high-reasoning models. We recommend Opus 4.5 and GPT 5.2 for both planning and implementation.
|
|
165
|
+
|
|
166
|
+
**Context hygiene**: BR-OpenSpec benefits from a clean context window. Clear your context before starting implementation and maintain good context hygiene throughout your session.
|
|
167
|
+
|
|
168
|
+
## Contributing
|
|
169
|
+
|
|
170
|
+
**Small fixes** — Bug fixes, typo corrections, and minor improvements can be submitted directly as PRs.
|
|
171
|
+
|
|
172
|
+
**Larger changes** — For new features, significant refactors, or architectural changes, please submit a BR-OpenSpec change proposal first so we can align on intent and goals before implementation begins.
|
|
173
|
+
|
|
174
|
+
When writing proposals, keep the BR-OpenSpec philosophy in mind: we serve a wide variety of users across different coding agents, models, and use cases. Changes should work well for everyone.
|
|
175
|
+
|
|
176
|
+
**AI-generated code is welcome** — as long as it's been tested and verified. PRs containing AI-generated code should mention the coding agent and model used (e.g., "Generated with Claude Code using claude-opus-4-5-20251101").
|
|
177
|
+
|
|
178
|
+
### Development
|
|
179
|
+
|
|
180
|
+
- Install dependencies: `pnpm install`
|
|
181
|
+
- Build: `pnpm run build`
|
|
182
|
+
- Test: `pnpm test`
|
|
183
|
+
- Develop CLI locally: `pnpm run dev` or `pnpm run dev:cli`
|
|
184
|
+
- Conventional commits (one-line): `type(scope): subject`
|
|
185
|
+
|
|
186
|
+
## Other
|
|
187
|
+
|
|
188
|
+
<details>
|
|
189
|
+
<summary><strong>Telemetry</strong></summary>
|
|
190
|
+
|
|
191
|
+
BR-OpenSpec collects anonymous usage stats.
|
|
192
|
+
|
|
193
|
+
We collect only command names and version to understand usage patterns. No arguments, paths, content, or PII. Automatically disabled in CI.
|
|
194
|
+
|
|
195
|
+
**Opt-out:** `export OPENSPEC_TELEMETRY=0` or `export DO_NOT_TRACK=1`
|
|
196
|
+
|
|
197
|
+
</details>
|
|
198
|
+
|
|
199
|
+
<details>
|
|
200
|
+
<summary><strong>Maintainers & Advisors</strong></summary>
|
|
201
|
+
|
|
202
|
+
See [MAINTAINERS.md](MAINTAINERS.md) for the list of core maintainers and advisors who help guide the project.
|
|
203
|
+
|
|
204
|
+
</details>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
## License
|
|
209
|
+
|
|
210
|
+
MIT
|
package/README.pt-BR.md
ADDED
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/dynamicworks-com-br/BR-OpenSpec">
|
|
3
|
+
<picture>
|
|
4
|
+
<source srcset="assets/openspec_bg.png">
|
|
5
|
+
<img src="assets/openspec_bg.png" alt="OpenSpec logo">
|
|
6
|
+
</picture>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<a href="https://github.com/dynamicworks-com-br/BR-OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/dynamicworks-com-br/BR-OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
|
|
12
|
+
<a href="https://www.npmjs.com/package/@dynamicworks/br-openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@dynamicworks/br-openspec?style=flat-square" /></a>
|
|
13
|
+
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
<details>
|
|
17
|
+
<summary><strong>O framework de spec mais querido.</strong></summary>
|
|
18
|
+
|
|
19
|
+
[](https://github.com/dynamicworks-com-br/BR-OpenSpec/stargazers)
|
|
20
|
+
[](https://www.npmjs.com/package/@dynamicworks/br-openspec)
|
|
21
|
+
[](https://github.com/dynamicworks-com-br/BR-OpenSpec/graphs/contributors)
|
|
22
|
+
|
|
23
|
+
</details>
|
|
24
|
+
<p></p>
|
|
25
|
+
Nossa filosofia:
|
|
26
|
+
|
|
27
|
+
> Esta filosofia foi definida pelo projeto original [OpenSpec](https://github.com/tab-tools/openspec) e o BR-OpenSpec fará o possível para honrá-la em cada decisão.
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
→ fluido, não rígido
|
|
31
|
+
→ iterativo, não em cascata
|
|
32
|
+
→ simples, não complexo
|
|
33
|
+
→ feito para brownfield, não apenas greenfield
|
|
34
|
+
→ escalável de projetos pessoais a empresas
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
> [!TIP]
|
|
38
|
+
> **Novo fluxo de trabalho disponível!** Reconstruímos o BR-OpenSpec com um novo fluxo de trabalho guiado por artefatos.
|
|
39
|
+
>
|
|
40
|
+
> Execute `/opsx:propose "sua ideia"` para começar. → [Saiba mais aqui](docs/pt-BR/opsx.md)
|
|
41
|
+
|
|
42
|
+
<p align="center">
|
|
43
|
+
Siga <a href="https://x.com/0xTab">@0xTab no X</a> para atualizações.
|
|
44
|
+
</p>
|
|
45
|
+
|
|
46
|
+
<!-- TODO: Add GIF demo of /opsx:propose → /opsx:archive workflow -->
|
|
47
|
+
|
|
48
|
+
## Veja em ação
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
Você: /opsx:propose add-dark-mode
|
|
52
|
+
IA: Criado openspec/changes/add-dark-mode/
|
|
53
|
+
✓ proposal.md — por que estamos fazendo isso, o que está mudando
|
|
54
|
+
✓ specs/ — requisitos e cenários
|
|
55
|
+
✓ design.md — abordagem técnica
|
|
56
|
+
✓ tasks.md — checklist de implementação
|
|
57
|
+
Pronto para implementação!
|
|
58
|
+
|
|
59
|
+
Você: /opsx:apply
|
|
60
|
+
IA: Implementando tarefas...
|
|
61
|
+
✓ 1.1 Adicionar provedor de contexto de tema
|
|
62
|
+
✓ 1.2 Criar componente de alternância
|
|
63
|
+
✓ 2.1 Adicionar variáveis CSS
|
|
64
|
+
✓ 2.2 Conectar localStorage
|
|
65
|
+
Todas as tarefas concluídas!
|
|
66
|
+
|
|
67
|
+
Você: /opsx:archive
|
|
68
|
+
IA: Arquivado em openspec/changes/archive/2025-01-23-add-dark-mode/
|
|
69
|
+
Specs atualizadas. Pronto para a próxima funcionalidade.
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
<details>
|
|
73
|
+
<summary><strong>Dashboard do BR-OpenSpec</strong></summary>
|
|
74
|
+
|
|
75
|
+
<p align="center">
|
|
76
|
+
<img src="assets/openspec_dashboard.png" alt="OpenSpec dashboard preview" width="90%">
|
|
77
|
+
</p>
|
|
78
|
+
|
|
79
|
+
</details>
|
|
80
|
+
|
|
81
|
+
## Início Rápido
|
|
82
|
+
|
|
83
|
+
**Requer Node.js 20.19.0 ou superior.**
|
|
84
|
+
|
|
85
|
+
Instale o BR-OpenSpec globalmente:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npm install -g @dynamicworks/br-openspec@latest
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Em seguida, navegue até o diretório do seu projeto e inicialize:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
cd your-project
|
|
95
|
+
openspec init
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Agora diga à sua IA: `/opsx:propose <o-que-você-quer-construir>`
|
|
99
|
+
|
|
100
|
+
Se você quiser o fluxo de trabalho expandido (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:sync`, `/opsx:bulk-archive`, `/opsx:onboard`), selecione-o com `openspec config profile` e aplique com `openspec update`.
|
|
101
|
+
|
|
102
|
+
> [!NOTE]
|
|
103
|
+
> Não tem certeza se sua ferramenta é suportada? [Veja a lista completa](docs/pt-BR/supported-tools.md) – suportamos mais de 25 ferramentas e crescendo.
|
|
104
|
+
>
|
|
105
|
+
> Também funciona com pnpm, yarn, bun e nix. [Veja as opções de instalação](docs/pt-BR/installation.md).
|
|
106
|
+
|
|
107
|
+
## Documentação
|
|
108
|
+
|
|
109
|
+
→ **[Primeiros Passos](docs/pt-BR/getting-started.md)**: primeiros passos<br>
|
|
110
|
+
→ **[Fluxos de Trabalho](docs/pt-BR/workflows.md)**: combinações e padrões<br>
|
|
111
|
+
→ **[Comandos](docs/pt-BR/commands.md)**: slash commands e skills<br>
|
|
112
|
+
→ **[CLI](docs/pt-BR/cli.md)**: referência do terminal<br>
|
|
113
|
+
→ **[Ferramentas Suportadas](docs/pt-BR/supported-tools.md)**: integrações e caminhos de instalação<br>
|
|
114
|
+
→ **[Conceitos](docs/pt-BR/concepts.md)**: como tudo se encaixa<br>
|
|
115
|
+
→ **[Multi-Idioma](docs/pt-BR/multi-language.md)**: suporte a múltiplos idiomas<br>
|
|
116
|
+
→ **[Personalização](docs/pt-BR/customization.md)**: faça do seu jeito
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
## Por que o BR-OpenSpec?
|
|
120
|
+
|
|
121
|
+
Assistentes de codificação com IA são poderosos, mas imprevisíveis quando os requisitos vivem apenas no histórico do chat. O BR-OpenSpec adiciona uma camada leve de especificação para que você concorde sobre o que construir antes de qualquer código ser escrito.
|
|
122
|
+
|
|
123
|
+
> **Por que este fork?** O BR-OpenSpec é mantido em **Português Brasileiro** e destina-se a quem implementa e mantém projetos com domínios de negócio primariamente em pt-BR, bem como a quem não tem o inglês como língua nativa. Ter specs, propostas e tarefas no idioma do time e do negócio reduz o risco de interpretações erradas e acelera o alinhamento entre humanos e IA.
|
|
124
|
+
|
|
125
|
+
- **Alinhe antes de construir** — humano e IA alinham as specs antes de o código ser escrito
|
|
126
|
+
- **Mantenha-se organizado** — cada mudança tem sua própria pasta com proposta, specs, design e tarefas
|
|
127
|
+
- **Trabalhe com fluidez** — atualize qualquer artefato a qualquer momento, sem fases rígidas
|
|
128
|
+
- **Use suas ferramentas** — funciona com mais de 20 assistentes de IA via slash commands
|
|
129
|
+
|
|
130
|
+
### Como nos comparamos
|
|
131
|
+
|
|
132
|
+
**vs. [Spec Kit](https://github.com/github/spec-kit)** (GitHub) — Completo, mas pesado. Fases rígidas, muito Markdown, configuração em Python. O BR-OpenSpec é mais leve e permite iterar livremente.
|
|
133
|
+
|
|
134
|
+
**vs. [Kiro](https://kiro.dev)** (AWS) — Poderoso, mas você fica preso à IDE deles e limitado aos modelos Claude. O BR-OpenSpec funciona com as ferramentas que você já usa.
|
|
135
|
+
|
|
136
|
+
**vs. nada** — Codificação com IA sem specs significa prompts vagos e resultados imprevisíveis. O BR-OpenSpec traz previsibilidade sem a burocracia.
|
|
137
|
+
|
|
138
|
+
## Atualizando o BR-OpenSpec
|
|
139
|
+
|
|
140
|
+
**Atualize o pacote**
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
npm install -g @dynamicworks/br-openspec@latest
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**Atualize as instruções do agente**
|
|
147
|
+
|
|
148
|
+
Execute dentro de cada projeto para regenerar a orientação da IA e garantir que os slash commands mais recentes estejam ativos:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
openspec update
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**Gerenciar configurações de IDE/Code Agent**
|
|
155
|
+
|
|
156
|
+
Adicione ou remova integrações de IDE e Code Agent suportadas sem precisar executar `init` novamente:
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
openspec tools # lista interativa
|
|
160
|
+
openspec tools --add claude,cursor
|
|
161
|
+
openspec tools --remove windsurf
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## Notas de Uso
|
|
165
|
+
|
|
166
|
+
**Seleção de modelo**: O BR-OpenSpec funciona melhor com modelos de alto raciocínio. Recomendamos Opus 4.5 e GPT 5.2 tanto para planejamento quanto para implementação.
|
|
167
|
+
|
|
168
|
+
**Higiene de contexto**: O BR-OpenSpec se beneficia de uma janela de contexto limpa. Limpe seu contexto antes de iniciar a implementação e mantenha uma boa higiene de contexto ao longo da sua sessão.
|
|
169
|
+
|
|
170
|
+
## Contribuindo
|
|
171
|
+
|
|
172
|
+
**Pequenas correções** — Correções de bugs, erros de digitação e melhorias menores podem ser enviadas diretamente como PRs.
|
|
173
|
+
|
|
174
|
+
**Mudanças maiores** — Para novas funcionalidades, refatorações significativas ou mudanças arquiteturais, envie primeiro uma proposta de mudança do BR-OpenSpec para que possamos alinhar a intenção e os objetivos antes de começar a implementação.
|
|
175
|
+
|
|
176
|
+
Ao escrever propostas, tenha em mente a filosofia do BR-OpenSpec: servimos a uma grande variedade de usuários em diferentes agentes de codificação, modelos e casos de uso. As mudanças devem funcionar bem para todos.
|
|
177
|
+
|
|
178
|
+
**Código gerado por IA é bem-vindo** — desde que tenha sido testado e verificado. PRs contendo código gerado por IA devem mencionar o agente de codificação e o modelo usado (ex.: "Gerado com Claude Code usando claude-opus-4-5-20251101").
|
|
179
|
+
|
|
180
|
+
### Desenvolvimento
|
|
181
|
+
|
|
182
|
+
- Instalar dependências: `pnpm install`
|
|
183
|
+
- Compilar: `pnpm run build`
|
|
184
|
+
- Testar: `pnpm test`
|
|
185
|
+
- Desenvolver CLI localmente: `pnpm run dev` ou `pnpm run dev:cli`
|
|
186
|
+
- Commits convencionais (uma linha): `type(scope): subject`
|
|
187
|
+
|
|
188
|
+
## Outros
|
|
189
|
+
|
|
190
|
+
<details>
|
|
191
|
+
<summary><strong>Telemetria</strong></summary>
|
|
192
|
+
|
|
193
|
+
O BR-OpenSpec coleta estatísticas de uso anônimas.
|
|
194
|
+
|
|
195
|
+
Coletamos apenas nomes de comandos e versão para entender padrões de uso. Sem argumentos, caminhos, conteúdo ou PII. Desativado automaticamente em CI.
|
|
196
|
+
|
|
197
|
+
**Desativar:** `export OPENSPEC_TELEMETRY=0` ou `export DO_NOT_TRACK=1`
|
|
198
|
+
|
|
199
|
+
</details>
|
|
200
|
+
|
|
201
|
+
<details>
|
|
202
|
+
<summary><strong>Mantenedores e Consultores</strong></summary>
|
|
203
|
+
|
|
204
|
+
Veja [MAINTAINERS.md](MAINTAINERS.md) para a lista de mantenedores principais e consultores que ajudam a guiar o projeto.
|
|
205
|
+
|
|
206
|
+
</details>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
## Licença
|
|
211
|
+
|
|
212
|
+
MIT
|
package/bin/openspec.js
ADDED