Skip to content

Commit 4723127

Browse files
authored
[codex] Include sync in core workflow defaults (Fission-AI#1030)
* Include sync in core workflow defaults * Add old core custom profile sync hint * Update workflows sync default docs
1 parent 0493c5f commit 4723127

17 files changed

Lines changed: 126 additions & 54 deletions

.changeset/sync-default-core.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@fission-ai/openspec": minor
3+
---
4+
5+
### New Features
6+
7+
- Include the sync workflow in the default core profile so new installs generate `/opsx:sync` skills and commands by default.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ openspec init
9696

9797
Now tell your AI: `/opsx:propose <what-you-want-to-build>`
9898

99-
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`.
99+
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`.
100100

101101
> [!NOTE]
102102
> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 25+ tools and growing.

docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ These options work with all commands:
6767

6868
Initialize OpenSpec in your project. Creates the folder structure and configures AI tool integrations.
6969

70-
Default behavior uses global config defaults: profile `core`, delivery `both`, workflows `propose, explore, apply, archive`.
70+
Default behavior uses global config defaults: profile `core`, delivery `both`, workflows `propose, explore, apply, sync, archive`.
7171

7272
```
7373
openspec init [path] [options]

docs/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ For workflow patterns and when to use each command, see [Workflows](workflows.md
1313
| `/opsx:propose` | Create a change and generate planning artifacts in one step |
1414
| `/opsx:explore` | Think through ideas before committing to a change |
1515
| `/opsx:apply` | Implement tasks from the change |
16+
| `/opsx:sync` | Merge delta specs into main specs |
1617
| `/opsx:archive` | Archive a completed change |
1718

1819
### Expanded Workflow Commands (custom workflow selection)
@@ -23,7 +24,6 @@ For workflow patterns and when to use each command, see [Workflows](workflows.md
2324
| `/opsx:continue` | Create the next artifact based on dependencies |
2425
| `/opsx:ff` | Fast-forward: create all planning artifacts at once |
2526
| `/opsx:verify` | Validate implementation matches artifacts |
26-
| `/opsx:sync` | Merge delta specs into main specs |
2727
| `/opsx:bulk-archive` | Archive multiple changes at once |
2828
| `/opsx:onboard` | Guided tutorial through the complete workflow |
2929

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OpenSpec helps you and your AI coding assistant agree on what to build before an
99
**Default quick path (core profile):**
1010

1111
```text
12-
/opsx:propose ──► /opsx:apply ──► /opsx:archive
12+
/opsx:propose ──► /opsx:apply ──► /opsx:sync ──► /opsx:archive
1313
```
1414

1515
**Expanded path (custom workflow selection):**
@@ -18,7 +18,7 @@ OpenSpec helps you and your AI coding assistant agree on what to build before an
1818
/opsx:new ──► /opsx:ff or /opsx:continue ──► /opsx:apply ──► /opsx:verify ──► /opsx:archive
1919
```
2020

21-
The default global profile is `core`, which includes `propose`, `explore`, `apply`, and `archive`. You can enable the expanded workflow commands with `openspec config profile` and then `openspec update`.
21+
The default global profile is `core`, which includes `propose`, `explore`, `apply`, `sync`, and `archive`. You can enable the expanded workflow commands with `openspec config profile` and then `openspec update`.
2222

2323
## What OpenSpec Creates
2424

docs/migration-guide.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ OPSX replaces the old phase-locked workflow with a fluid, action-based approach.
88

99
| Aspect | Legacy | OPSX |
1010
|--------|--------|------|
11-
| **Commands** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` | Default: `/opsx:propose`, `/opsx:apply`, `/opsx:archive` (expanded workflow commands optional) |
11+
| **Commands** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` | Default: `/opsx:propose`, `/opsx:apply`, `/opsx:sync`, `/opsx:archive` (expanded workflow commands optional) |
1212
| **Workflow** | Create all artifacts at once | Create incrementally or all at once—your choice |
1313
| **Going back** | Awkward phase gates | Natural—update any artifact anytime |
1414
| **Customization** | Fixed structure | Schema-driven, fully hackable |
@@ -84,7 +84,7 @@ Don't worry about getting it perfect. We're still learning what works best here,
8484

8585
Both `openspec init` and `openspec update` detect legacy files and guide you through the same cleanup process. Use whichever fits your situation:
8686

87-
- New installs default to profile `core` (`propose`, `explore`, `apply`, `archive`).
87+
- New installs default to profile `core` (`propose`, `explore`, `apply`, `sync`, `archive`).
8888
- Migrated installs preserve your previously installed workflows by writing a `custom` profile when needed.
8989

9090
### Using `openspec init`
@@ -561,6 +561,7 @@ project/
561561
│ ├── openspec-propose/ # default core profile
562562
│ ├── openspec-explore/
563563
│ ├── openspec-apply-change/
564+
│ ├── openspec-sync-specs/
564565
│ └── ... # expanded profile adds new/continue/ff/etc.
565566
├── CLAUDE.md # OpenSpec markers removed, your content preserved
566567
└── AGENTS.md # OpenSpec markers removed, your content preserved

docs/opsx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ openspec init
6565

6666
This creates skills in `.claude/skills/` (or equivalent) that AI coding assistants auto-detect.
6767

68-
By default, OpenSpec uses the `core` workflow profile (`propose`, `explore`, `apply`, `archive`). If you want the expanded workflow commands (`new`, `continue`, `ff`, `verify`, `sync`, `bulk-archive`, `onboard`), configure them with `openspec config profile` and apply with `openspec update`.
68+
By default, OpenSpec uses the `core` workflow profile (`propose`, `explore`, `apply`, `sync`, `archive`). If you want the expanded workflow commands (`new`, `continue`, `ff`, `verify`, `bulk-archive`, `onboard`), configure them with `openspec config profile` and apply with `openspec update`.
6969

7070
During setup, you'll be prompted to create a **project config** (`openspec/config.yaml`). This is optional but recommended.
7171

@@ -164,7 +164,7 @@ rules:
164164
| `/opsx:ff` | Fast-forward planning artifacts (expanded workflow) |
165165
| `/opsx:apply` | Implement tasks, updating artifacts as needed |
166166
| `/opsx:verify` | Validate implementation against artifacts (expanded workflow) |
167-
| `/opsx:sync` | Sync delta specs to main (expanded workflow, optional) |
167+
| `/opsx:sync` | Sync delta specs to main (default workflow, optional) |
168168
| `/opsx:archive` | Archive when done |
169169
| `/opsx:bulk-archive` | Archive multiple completed changes (expanded workflow) |
170170
| `/opsx:onboard` | Guided walkthrough of an end-to-end change (expanded workflow) |
@@ -313,7 +313,7 @@ Think of it like git branches:
313313
## Architecture Deep Dive
314314

315315
This section explains how OPSX works under the hood and how it compares to the legacy workflow.
316-
Examples in this section use the expanded command set (`new`, `continue`, etc.); default `core` users can map the same flow to `propose → apply → archive`.
316+
Examples in this section use the expanded command set (`new`, `continue`, etc.); default `core` users can map the same flow to `propose → apply → sync → archive`.
317317

318318
### Philosophy: Phases vs Actions
319319

docs/supported-tools.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ By default, OpenSpec uses the `core` profile, which includes:
1313
- `propose`
1414
- `explore`
1515
- `apply`
16+
- `sync`
1617
- `archive`
1718

18-
You can enable expanded workflows (`new`, `continue`, `ff`, `verify`, `sync`, `bulk-archive`, `onboard`) via `openspec config profile`, then run `openspec update`.
19+
You can enable expanded workflows (`new`, `continue`, `ff`, `verify`, `bulk-archive`, `onboard`) via `openspec config profile`, then run `openspec update`.
1920

2021
## Tool Directory Reference
2122

@@ -79,7 +80,7 @@ openspec init --profile core
7980

8081
OpenSpec installs workflow artifacts based on selected workflows:
8182

82-
- **Core profile (default):** `propose`, `explore`, `apply`, `archive`
83+
- **Core profile (default):** `propose`, `explore`, `apply`, `sync`, `archive`
8384
- **Custom selection:** any subset of all workflow IDs:
8485
`propose`, `explore`, `new`, `continue`, `apply`, `ff`, `sync`, `archive`, `bulk-archive`, `verify`, `onboard`
8586

docs/workflows.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,18 @@ New installs default to `core`, which provides:
3636
- `/opsx:propose`
3737
- `/opsx:explore`
3838
- `/opsx:apply`
39+
- `/opsx:sync`
3940
- `/opsx:archive`
4041

4142
Typical flow:
4243

4344
```text
44-
/opsx:propose ──► /opsx:apply ──► /opsx:archive
45+
/opsx:propose ──► /opsx:apply ──► /opsx:sync ──► /opsx:archive
4546
```
4647

4748
### Expanded/Full Workflow (custom selection)
4849

49-
If you want explicit scaffold-and-build commands (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:sync`, `/opsx:bulk-archive`, `/opsx:onboard`), enable them with:
50+
If you want explicit scaffold-and-build commands (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:bulk-archive`, `/opsx:onboard`), enable them with:
5051

5152
```bash
5253
openspec config profile

src/core/profiles.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import type { Profile } from './global-config.js';
1111
* Core workflows included in the 'core' profile.
1212
* These provide the streamlined experience for new users.
1313
*/
14-
export const CORE_WORKFLOWS = ['propose', 'explore', 'apply', 'archive'] as const;
14+
export const CORE_WORKFLOWS = ['propose', 'explore', 'apply', 'sync', 'archive'] as const;
1515

1616
/**
1717
* All available workflows in the system.

0 commit comments

Comments
 (0)