Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Use this structure for your changeset content:

```markdown
---
"@fission-ai/openspec": patch
"@codewalla_india/openspec": patch
---

### New Features
Expand Down
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://unpkg.com/@changesets/config/schema.json",
"changelog": [
"@changesets/changelog-github",
{ "repo": "Fission-AI/OpenSpec" }
{ "repo": "codewalla-engineering/OpenSpec" }
],
"commit": false,
"fixed": [],
Expand Down
2 changes: 1 addition & 1 deletion .changeset/escape-yaml-carriage-return.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
"@fission-ai/openspec": patch
"@codewalla_india/openspec": patch
---

fix(adapters): escape carriage returns in generated YAML frontmatter
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-prepare.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ concurrency:

jobs:
prepare:
if: github.repository == 'Fission-AI/OpenSpec'
if: github.repository == 'codewalla-engineering/OpenSpec'
runs-on: ubuntu-latest
steps:
# Generate GitHub App token first - used for checkout and changesets
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,5 @@ opencode.json

# Bob
.bob/
.cursor/...
.windsurf/...
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @fission-ai/openspec
# @codewalla_india/openspec

## 1.4.1

Expand Down
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://github.com/Fission-AI/OpenSpec">
<a href="https://github.com/codewalla-engineering/OpenSpec">
<picture>
<source srcset="assets/openspec_bg.png">
<img src="assets/openspec_bg.png" alt="OpenSpec logo">
Expand All @@ -8,18 +8,18 @@
</p>

<p align="center">
<a href="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://www.npmjs.com/package/@fission-ai/openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@fission-ai/openspec?style=flat-square" /></a>
<a href="https://github.com/codewalla-engineering/OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/codewalla-engineering/OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://www.npmjs.com/package/@codewalla_india/openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@codewalla_india/openspec?style=flat-square" /></a>
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
<a href="https://discord.gg/YctCnvvshC"><img alt="Discord" src="https://img.shields.io/discord/1411657095639601154?style=flat-square&logo=discord&logoColor=white&label=Discord&suffix=%20online" /></a>
</p>

<details>
<summary><strong>The most loved spec framework.</strong></summary>

[![Stars](https://img.shields.io/github/stars/Fission-AI/OpenSpec?style=flat-square&label=Stars)](https://github.com/Fission-AI/OpenSpec/stargazers)
[![Downloads](https://img.shields.io/npm/dm/@fission-ai/openspec?style=flat-square&label=Downloads/mo)](https://www.npmjs.com/package/@fission-ai/openspec)
[![Contributors](https://img.shields.io/github/contributors/Fission-AI/OpenSpec?style=flat-square&label=Contributors)](https://github.com/Fission-AI/OpenSpec/graphs/contributors)
[![Stars](https://img.shields.io/github/stars/codewalla-engineering/OpenSpec?style=flat-square&label=Stars)](https://github.com/codewalla-engineering/OpenSpec/stargazers)
[![Downloads](https://img.shields.io/npm/dm/@codewalla_india/openspec?style=flat-square&label=Downloads/mo)](https://www.npmjs.com/package/@codewalla_india/openspec)
[![Contributors](https://img.shields.io/github/contributors/codewalla-engineering/OpenSpec?style=flat-square&label=Contributors)](https://github.com/codewalla-engineering/OpenSpec/graphs/contributors)

</details>
<p></p>
Expand Down Expand Up @@ -64,7 +64,9 @@ AI: Created openspec/changes/add-dark-mode/
Ready for implementation!

You: /opsx:apply
AI: Implementing tasks...
AI: Comprehension check — 6 questions on your proposal, design, specs, and tasks...
✓ 83% — ready to implement.
Implementing tasks...
✓ 1.1 Add theme context provider
✓ 1.2 Create toggle component
✓ 2.1 Add CSS variables
Expand Down Expand Up @@ -92,7 +94,7 @@ AI: Archived to openspec/changes/archive/2025-01-23-add-dark-mode/
Install OpenSpec globally:

```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
```

Then navigate to your project directory and initialize:
Expand All @@ -106,8 +108,9 @@ Now talk to your AI:

- **Not sure what to build yet?** Start with `/opsx:explore`, a no-stakes thinking partner that reads your code, weighs options, and shapes a plan before anything is written. ([Explore guide](docs/explore.md))
- **Already know what you want?** Go straight to `/opsx:propose <what-you-want-to-build>`.
- **Ready to implement?** Run `/opsx:apply` — a short comprehension quiz checks you understand the proposal, design, specs, and tasks before any code is written.

Both are in the default profile. If you want the expanded workflow (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:bulk-archive`, `/opsx:onboard`), select it with `openspec config profile` and apply with `openspec update`.
The default `core` profile includes `/opsx:explore`, `/opsx:propose`, `/opsx:apply`, `/opsx:sync`, and `/opsx:archive`. If you want the expanded workflow (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:bulk-archive`, `/opsx:onboard`), select it with `openspec config profile` and apply with `openspec update`.

> [!NOTE]
> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 25+ tools and growing.
Expand Down Expand Up @@ -165,7 +168,7 @@ AI coding assistants are powerful but unpredictable when requirements live only
**Upgrade the package**

```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
```

**Refresh agent instructions**
Expand All @@ -182,6 +185,8 @@ openspec update

**Context hygiene**: OpenSpec benefits from a clean context window. Clear your context before starting implementation and maintain good context hygiene throughout your session.

**Comprehension check**: `/opsx:apply` runs a short quiz (enabled by default) on proposal, design, specs, and pending tasks before implementation. Questions test holistic understanding of the change, not task numbers or checklist trivia. Disable with `comprehension.enabled: false` in `openspec/config.yaml`. See [Workflows](docs/workflows.md#comprehension-quiz-before-apply).

## Contributing

**Small fixes** — Bug fixes, typo corrections, and minor improvements can be submitted directly as PRs.
Expand Down
18 changes: 9 additions & 9 deletions README_OLD.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://github.com/Fission-AI/OpenSpec">
<a href="https://github.com/codewalla-engineering/OpenSpec">
<picture>
<source srcset="assets/openspec_pixel_dark.svg" media="(prefers-color-scheme: dark)">
<source srcset="assets/openspec_pixel_light.svg" media="(prefers-color-scheme: light)">
Expand All @@ -10,9 +10,9 @@
</p>
<p align="center">Spec-driven development for AI coding assistants.</p>
<p align="center">
<a href="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/Fission-AI/OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://www.npmjs.com/package/@fission-ai/openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@fission-ai/openspec?style=flat-square" /></a>
<a href="https://nodejs.org/"><img alt="node version" src="https://img.shields.io/node/v/@fission-ai/openspec?style=flat-square" /></a>
<a href="https://github.com/codewalla-engineering/OpenSpec/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/codewalla-engineering/OpenSpec/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://www.npmjs.com/package/@codewalla_india/openspec"><img alt="npm version" src="https://img.shields.io/npm/v/@codewalla_india/openspec?style=flat-square" /></a>
<a href="https://nodejs.org/"><img alt="node version" src="https://img.shields.io/node/v/@codewalla_india/openspec?style=flat-square" /></a>
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
<a href="https://conventionalcommits.org"><img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" /></a>
<a href="https://discord.gg/YctCnvvshC"><img alt="Discord" src="https://img.shields.io/badge/Discord-Join%20the%20community-5865F2?logo=discord&logoColor=white&style=flat-square" /></a>
Expand Down Expand Up @@ -143,7 +143,7 @@ These tools automatically read workflow instructions from `openspec/AGENTS.md`.
**Option A: Using npm**

```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
```

Verify installation:
Expand All @@ -155,20 +155,20 @@ openspec --version

Run OpenSpec directly without installation:
```bash
nix run github:Fission-AI/OpenSpec -- init
nix run github:codewalla-engineering/OpenSpec -- init
```

Or install to your profile:
```bash
nix profile install github:Fission-AI/OpenSpec
nix profile install github:codewalla-engineering/OpenSpec
```

Or add to your development environment in `flake.nix`:
```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
openspec.url = "github:Fission-AI/OpenSpec";
openspec.url = "github:codewalla-engineering/OpenSpec";
};

outputs = { nixpkgs, openspec, ... }: {
Expand Down Expand Up @@ -403,7 +403,7 @@ Run `openspec update` whenever someone switches tools so your agents pick up the

1. **Upgrade the package**
```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
```
2. **Refresh agent instructions**
- Run `openspec update` inside each project to regenerate AI guidance and ensure the latest slash commands are active.
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ That second one matters more than it looks. OpenSpec has two halves: a command l
## The thirty-second version

```text
1. Install npm install -g @fission-ai/openspec@latest
1. Install npm install -g @codewalla_india/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← optional, but a great habit
4. Propose (in your AI chat) /opsx:propose add-dark-mode
Expand All @@ -101,7 +101,7 @@ Steps 1 and 2 happen in your terminal. The rest happen in your AI assistant's ch
## Where else to get help

- **Discord:** [discord.gg/YctCnvvshC](https://discord.gg/YctCnvvshC) for questions, ideas, and help.
- **GitHub Issues:** [github.com/Fission-AI/OpenSpec/issues](https://github.com/Fission-AI/OpenSpec/issues) for bugs and feature requests.
- **GitHub Issues:** [github.com/codewalla-engineering/OpenSpec/issues](https://github.com/codewalla-engineering/OpenSpec/issues) for bugs and feature requests.
- **`openspec feedback "your message"`** sends feedback straight from your terminal (it opens a GitHub issue).

Found something in these docs that's wrong, stale, or confusing? That's a bug. Open an issue or a PR. Documentation improvements are some of the most valuable contributions you can make.
2 changes: 1 addition & 1 deletion docs/agent-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Change: `{ "id", "title", "deltaCount", "deltas": [...], "root" }`. Spec: `{ "id
### 4.6 `instructions apply --json`
`{ "changeName", "changeDir", "schemaName", "contextFiles": { "<artifactId>": ["/abs", ...] }, "progress": {total,complete,remaining}, "tasks": [{id,description,done}], "state": "blocked"|"all_done"|"ready", "missingArtifacts"?, "missingComprehension"?, "comprehension"?: { "required", "passed", "thresholdPercent", "bestScorePercent"?, "questionCount", "requirementCount", "scenarioCount", "pendingTaskCount", "attempts"? }, "instruction", "references"?, "root" }`.

When comprehension is required and not passed, `state` is `"blocked"` and `missingComprehension` is `true`.
When comprehension is required and not passed, `state` is `"blocked"` and `missingComprehension` is `true`. The blocked `instruction` references proposal, design, specs, and tasks; agents generate quiz questions from those artifacts (not task numbers or verbatim checkbox text).

Record pass: `openspec instructions apply --change <id> --record-comprehension-pass --score <0-100> [--attempt <n>] [--question-count <n>] --json` → `{ "recorded": true, "comprehensionPass": {...}, ...apply fields..., "root" }` or exit 1 with `comprehension_score_below_threshold`.

Expand Down
4 changes: 2 additions & 2 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ openspec update [path] [options]

```bash
# Update instruction files after npm upgrade
npm update @fission-ai/openspec
npm update @codewalla_india/openspec
openspec update
```

Expand Down Expand Up @@ -977,7 +977,7 @@ openspec schema which spec-driven

```
spec-driven resolves from: package
Source: /usr/local/lib/node_modules/@fission-ai/openspec/schemas/spec-driven
Source: /usr/local/lib/node_modules/@codewalla_india/openspec/schemas/spec-driven
```

**Schema precedence:**
Expand Down
2 changes: 1 addition & 1 deletion docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ comprehension:
max_questions: 10
```

Set `comprehension.enabled: false` to skip the spec and task quiz gate on `/opsx:apply`.
Set `comprehension.enabled: false` to skip the proposal/design/spec/task quiz gate on `/opsx:apply`.

### How It Works

Expand Down
6 changes: 3 additions & 3 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,18 +136,18 @@ It collects anonymous usage stats: command names and version only. No arguments,

### How do I upgrade?

Two steps. Upgrade the package (`npm install -g @fission-ai/openspec@latest`), then run `openspec update` inside each project to refresh the generated skills and commands.
Two steps. Upgrade the package (`npm install -g @codewalla_india/openspec@latest`), then run `openspec update` inside each project to refresh the generated skills and commands.

### How do I uninstall OpenSpec?

There's no uninstall command, because it's just a global package plus files in your project. Remove the package (`npm uninstall -g @fission-ai/openspec`), and optionally delete the `openspec/` directory and the generated tool files. Step-by-step, including what's safe to keep, is in [Installation: Uninstalling](installation.md#uninstalling).
There's no uninstall command, because it's just a global package plus files in your project. Remove the package (`npm uninstall -g @codewalla_india/openspec`), and optionally delete the `openspec/` directory and the generated tool files. Step-by-step, including what's safe to keep, is in [Installation: Uninstalling](installation.md#uninstalling).

## Getting help

### Where do I ask questions or report bugs?

- **Discord:** [discord.gg/YctCnvvshC](https://discord.gg/YctCnvvshC)
- **GitHub Issues:** [github.com/Fission-AI/OpenSpec/issues](https://github.com/Fission-AI/OpenSpec/issues)
- **GitHub Issues:** [github.com/codewalla-engineering/OpenSpec/issues](https://github.com/codewalla-engineering/OpenSpec/issues)
- **From your terminal:** `openspec feedback "your message"` opens a GitHub issue for you.

### These docs are wrong or confusing. What do I do?
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide explains how OpenSpec works after you've installed and initialized it
The whole loop, with each step labeled by where it happens:

```text
TERMINAL $ npm install -g @fission-ai/openspec@latest
TERMINAL $ npm install -g @codewalla_india/openspec@latest
TERMINAL $ cd your-project && openspec init
AI CHAT /opsx:explore (optional: think it through first)
AI CHAT /opsx:propose add-dark-mode (AI drafts the plan; you review it)
Expand Down
2 changes: 1 addition & 1 deletion docs/how-commands-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ For what each command does in detail, see [Commands](commands.md). For when to r
Putting it together, here is the whole sequence with each step labeled by where it happens.

```text
TERMINAL $ npm install -g @fission-ai/openspec@latest
TERMINAL $ npm install -g @codewalla_india/openspec@latest
TERMINAL $ cd your-project
TERMINAL $ openspec init
(installs slash commands into your AI tool)
Expand Down
18 changes: 9 additions & 9 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
### npm

```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
```

### pnpm

```bash
pnpm add -g @fission-ai/openspec@latest
pnpm add -g @codewalla_india/openspec@latest
```

### yarn

```bash
yarn global add @fission-ai/openspec@latest
yarn global add @codewalla_india/openspec@latest
```

### bun
Expand All @@ -30,21 +30,21 @@ Bun can install OpenSpec globally, but OpenSpec currently runs on Node.js.
You still need Node.js 20.19.0 or higher available on `PATH`.

```bash
bun add -g @fission-ai/openspec@latest
bun add -g @codewalla_india/openspec@latest
```

## Nix

Run OpenSpec directly without installation:

```bash
nix run github:Fission-AI/OpenSpec -- init
nix run github:codewalla-engineering/OpenSpec -- init
```

Or install to your profile:

```bash
nix profile install github:Fission-AI/OpenSpec
nix profile install github:codewalla-engineering/OpenSpec
```

Or add to your development environment in `flake.nix`:
Expand All @@ -53,7 +53,7 @@ Or add to your development environment in `flake.nix`:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
openspec.url = "github:Fission-AI/OpenSpec";
openspec.url = "github:codewalla-engineering/OpenSpec";
};

outputs = { nixpkgs, openspec, ... }: {
Expand All @@ -75,7 +75,7 @@ openspec --version
Upgrade the package, then refresh each project's generated files:

```bash
npm install -g @fission-ai/openspec@latest # or pnpm/yarn/bun equivalent
npm install -g @codewalla_india/openspec@latest # or pnpm/yarn/bun equivalent
openspec update # run inside each project
```

Expand All @@ -88,7 +88,7 @@ There's no `openspec uninstall` command, because OpenSpec is just a global packa
**1. Remove the global package:**

```bash
npm uninstall -g @fission-ai/openspec # or: pnpm rm -g / yarn global remove / bun rm -g
npm uninstall -g @codewalla_india/openspec # or: pnpm rm -g / yarn global remove / bun rm -g
```

**2. Remove OpenSpec from a project (optional).** Delete the `openspec/` directory if you no longer want its specs and changes:
Expand Down
2 changes: 1 addition & 1 deletion docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -592,5 +592,5 @@ project/
## Getting Help

- **Discord**: [discord.gg/YctCnvvshC](https://discord.gg/YctCnvvshC)
- **GitHub Issues**: [github.com/Fission-AI/OpenSpec/issues](https://github.com/Fission-AI/OpenSpec/issues)
- **GitHub Issues**: [github.com/codewalla-engineering/OpenSpec/issues](https://github.com/codewalla-engineering/OpenSpec/issues)
- **Documentation**: [docs/opsx.md](opsx.md) for the full OPSX reference
2 changes: 1 addition & 1 deletion docs/opsx.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,4 +656,4 @@ openspec schema validate my-workflow

This is rough. That's intentional — we're learning what works.

Found a bug? Have ideas? Join us on [Discord](https://discord.gg/YctCnvvshC) or open an issue on [GitHub](https://github.com/Fission-AI/openspec/issues).
Found a bug? Have ideas? Join us on [Discord](https://discord.gg/YctCnvvshC) or open an issue on [GitHub](https://github.com/codewalla-engineering/OpenSpec/issues).
4 changes: 2 additions & 2 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Concrete fixes for concrete problems. Each entry names a symptom, explains the l
The CLI isn't installed, or your shell can't find it. Install it globally and check:

```bash
npm install -g @fission-ai/openspec@latest
npm install -g @codewalla_india/openspec@latest
openspec --version
```

Expand Down Expand Up @@ -160,7 +160,7 @@ That's intentional. OpenSpec never deletes `project.md` automatically because it
## Still stuck?

- **Discord:** [discord.gg/YctCnvvshC](https://discord.gg/YctCnvvshC)
- **GitHub Issues:** [github.com/Fission-AI/OpenSpec/issues](https://github.com/Fission-AI/OpenSpec/issues)
- **GitHub Issues:** [github.com/codewalla-engineering/OpenSpec/issues](https://github.com/codewalla-engineering/OpenSpec/issues)
- **From your terminal:** `openspec feedback "what went wrong"` opens an issue for you.

When you report a problem, include your OpenSpec version (`openspec --version`), your Node version (`node --version`), your AI tool, and the exact command and output. It makes help much faster.
Loading
Loading