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
14 changes: 7 additions & 7 deletions docs/adapters/azuredevops.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The adapter automatically derives work item type from your project's process tem
You can override with `--ado-work-item-type`:

```bash
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org your-org \
--ado-project your-project \
--ado-work-item-type "Bug" \
Expand Down Expand Up @@ -434,7 +434,7 @@ This handles cases where:

```bash
# Export OpenSpec change proposals to Azure DevOps work items
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org your-org \
--ado-project your-project \
--repo /path/to/openspec-repo
Expand All @@ -444,7 +444,7 @@ specfact project sync bridge --adapter ado --mode export-only \

```bash
# Import work items AND export proposals
specfact project sync bridge --adapter ado --bidirectional \
specfact sync bridge --adapter ado --bidirectional \
--ado-org your-org \
--ado-project your-project \
--repo /path/to/openspec-repo
Expand All @@ -454,7 +454,7 @@ specfact project sync bridge --adapter ado --bidirectional \

```bash
# Import specific work items into bundle
specfact project sync bridge --adapter ado --mode bidirectional \
specfact sync bridge --adapter ado --mode bidirectional \
--ado-org your-org \
--ado-project your-project \
--bundle main \
Expand All @@ -466,7 +466,7 @@ specfact project sync bridge --adapter ado --mode bidirectional \

```bash
# Update existing work item with latest proposal content
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org your-org \
--ado-project your-project \
--change-ids add-feature-x \
Expand All @@ -478,7 +478,7 @@ specfact project sync bridge --adapter ado --mode export-only \

```bash
# Detect code changes and add progress comments
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org your-org \
--ado-project your-project \
--track-code-changes \
Expand All @@ -490,7 +490,7 @@ specfact project sync bridge --adapter ado --mode export-only \

```bash
# Export from bundle to ADO (uses stored lossless content)
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org your-org \
--ado-project your-project \
--bundle main \
Expand Down
8 changes: 4 additions & 4 deletions docs/adapters/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,14 +334,14 @@ To create a GitHub issue from an OpenSpec change and have the issue number/URL w

```bash
# Export one or more changes; creates issues and updates proposal.md Source Tracking
specfact project sync bridge --adapter github --mode export-only \
specfact sync bridge --adapter github --mode export-only \
--repo . \
--repo-owner nold-ai \
--repo-name specfact-cli \
--change-ids <change-id>

# Example: export backlog-scrum-05-summarize-markdown-output
specfact project sync bridge --adapter github --mode export-only \
specfact sync bridge --adapter github --mode export-only \
--repo . \
--repo-owner nold-ai \
--repo-name specfact-cli \
Expand All @@ -362,15 +362,15 @@ When you improve comment logic or branch detection, use `--include-archived` to

```bash
# Update all archived proposals with new comment logic
specfact project sync bridge --adapter github --mode export-only \
specfact sync bridge --adapter github --mode export-only \
--repo-owner your-org \
--repo-name your-repo \
--include-archived \
--update-existing \
--repo /path/to/openspec-repo

# Update specific archived proposal
specfact project sync bridge --adapter github --mode export-only \
specfact sync bridge --adapter github --mode export-only \
--repo-owner your-org \
--repo-name your-repo \
--change-ids add-code-change-tracking \
Expand Down
22 changes: 11 additions & 11 deletions docs/bundles/backlog/refinement.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ The most common workflow is to refine backlog items and then sync them to extern
**Workflow**: `backlog ceremony refinement` → `sync bridge`

1. **Refine Backlog Items**: Use `specfact backlog ceremony refinement` to standardize backlog items with templates
2. **Sync to External Tools**: Use `specfact project sync bridge` to sync refined items back to backlog tools (GitHub, ADO, etc.)
2. **Sync to External Tools**: Use `specfact sync bridge` to sync refined items back to backlog tools (GitHub, ADO, etc.)

```bash
# Complete command chaining workflow
Expand All @@ -567,7 +567,7 @@ specfact backlog ceremony refinement github \
--state open

# 2. Sync refined items to external tool (same or different adapter)
specfact project sync bridge --adapter github \
specfact sync bridge --adapter github \
--repo-owner my-org --repo-name my-repo \
--backlog-ids 123,456 \
--mode export-only
Expand All @@ -578,7 +578,7 @@ specfact backlog ceremony refinement github \
--write \
--labels feature

specfact project sync bridge --adapter ado \
specfact sync bridge --adapter ado \
--ado-org my-org --ado-project my-project \
--backlog-ids 123,456 \
--mode export-only
Expand Down Expand Up @@ -614,12 +614,12 @@ When syncing backlog items between different adapters (e.g., GitHub ↔ ADO), Sp

```bash
# 1. Import closed GitHub issues into bundle (state "closed" is preserved)
specfact project sync bridge --adapter github --mode bidirectional \
specfact sync bridge --adapter github --mode bidirectional \
--repo-owner nold-ai --repo-name specfact-cli \
--backlog-ids 110,122

# 2. Export to ADO (state is automatically mapped: closed → Closed)
specfact project sync bridge --adapter ado --mode export-only \
specfact sync bridge --adapter ado --mode export-only \
--ado-org dominikusnold --ado-project "SpecFact CLI" \
--bundle cross-sync-test --change-ids add-ado-backlog-adapter,add-template-driven-backlog-refinement

Expand All @@ -646,14 +646,14 @@ specfact project sync bridge --adapter ado --mode export-only \

Backlog refinement works seamlessly with the [DevOps Adapter Integration](/integrations/devops-adapter-overview/):

1. **Import Backlog Items**: Use `specfact project sync bridge` to import backlog items as OpenSpec proposals
1. **Import Backlog Items**: Use `specfact sync bridge` to import backlog items as OpenSpec proposals
2. **Refine Items**: Use `specfact backlog ceremony refinement` to standardize imported items
3. **Export Refined Items**: Use `specfact project sync bridge` to export refined proposals back to backlog tools
3. **Export Refined Items**: Use `specfact sync bridge` to export refined proposals back to backlog tools

```bash
# Complete workflow
# 1. Import GitHub issues as OpenSpec proposals
specfact project sync bridge --adapter github --mode bidirectional \
specfact sync bridge --adapter github --mode bidirectional \
--repo-owner my-org --repo-name my-repo \
--backlog-ids 123,456

Expand All @@ -662,7 +662,7 @@ specfact backlog ceremony refinement github --bundle my-project --auto-bundle \
--search "is:open"

# 3. Export refined proposals back to GitHub
specfact project sync bridge --adapter github --mode export-only \
specfact sync bridge --adapter github --mode export-only \
--bundle my-project --change-ids <refined-change-id>
```

Expand Down Expand Up @@ -937,11 +937,11 @@ If adapter search methods are not available:
# "Note: GitHub issue fetching requires adapter.search_issues() implementation"
```

**Workaround**: Use `specfact project sync bridge` to import backlog items first, then refine:
**Workaround**: Use `specfact sync bridge` to import backlog items first, then refine:

```bash
# 1. Import backlog items
specfact project sync bridge --adapter github --mode bidirectional \
specfact sync bridge --adapter github --mode bidirectional \
--backlog-ids 123,456

# 2. Refine imported items from bundle
Expand Down
4 changes: 2 additions & 2 deletions docs/bundles/govern/patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ specfact govern patch apply changes.patch --write --yes

## Related

- [Govern enforce](enforce/)
- [Govern bundle overview](overview/)
- [Govern enforce](/bundles/govern/enforce/)
- [Govern bundle overview](/bundles/govern/overview/)
2 changes: 1 addition & 1 deletion docs/getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,12 +280,12 @@ Convert an existing GitHub Spec-Kit project:

```bash
# Start a one-time import
specfact project sync bridge \
specfact sync bridge \
--adapter speckit \
--repo ./my-speckit-project

# Ongoing bidirectional sync (after migration)
specfact project sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional --watch
specfact sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional --watch
```

**Bidirectional Sync:**
Expand All @@ -294,13 +294,13 @@ Keep Spec-Kit and SpecFact artifacts synchronized:

```bash
# One-time sync
specfact project sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional
specfact sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional

# Continuous watch mode
specfact project sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional --watch
specfact sync bridge --adapter speckit --bundle <bundle-name> --repo . --bidirectional --watch
```

**Note**: SpecFact CLI uses a plugin-based adapter registry pattern. All adapters (Spec-Kit, OpenSpec, GitHub, etc.) are registered in `AdapterRegistry` and accessed via `specfact project sync bridge --adapter <adapter-name>`, making the architecture extensible for future tool integrations.
**Note**: SpecFact CLI uses a plugin-based adapter registry pattern. All adapters (Spec-Kit, OpenSpec, GitHub, etc.) are registered in `AdapterRegistry` and accessed via `specfact sync bridge --adapter <adapter-name>`, making the architecture extensible for future tool integrations.

### For Brownfield Projects

Expand Down Expand Up @@ -383,7 +383,7 @@ specfact project sync repository --repo . --watch
- **IDE integration**: Use `specfact init` to set up slash commands in IDE (requires pip install)
- **Slash commands**: Use the IDE templates generated for your checkout and keep them aligned with the mounted CLI surface
- **Global flags**: Place `--no-banner` before the command: `specfact --no-banner <command>`
- **Bridge adapter sync**: Use `project sync bridge --adapter <adapter-name>` for external tool integration (Spec-Kit, OpenSpec, GitHub, etc.)
- **Bridge adapter sync**: Use `sync bridge --adapter <adapter-name>` for external tool integration (Spec-Kit, OpenSpec, GitHub, etc.)
- **Repository sync**: Use `project sync repository` for code change tracking
- **Semgrep (optional)**: Install `pip install semgrep` for async pattern detection in `specfact code repro`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,6 @@ supported. Use it with the **`specfact.backlog-daily`** slash prompt for interac

## Related Documentation

- **[Agile/Scrum Workflows](../guides/agile-scrum-workflows.md)** — Daily standup, iteration/sprint, unassigned items, blockers-first
- **[Agile/Scrum Workflows](/guides/agile-scrum-workflows/)** — Daily standup, iteration/sprint, unassigned items, blockers-first
- **[DevOps Adapter Integration](/integrations/devops-adapter-overview/)** — Project backlog context (`.nold-ai/specfact-backlog.yaml`), env vars, **Git fallback (auto-detect from clone)** for GitHub and Azure DevOps
- **[Backlog Refinement Guide](/bundles/backlog/refinement/)** — Template-driven refinement (complementary to daily standup)
8 changes: 4 additions & 4 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ Practical module-owned guides for official bundles, adapters, publishing, and wo

- **[IDE Integration](ide-integration.md)** - Set up slash commands in your IDE
- **[CoPilot Mode](copilot-mode.md)** - Using `--mode copilot` on CLI commands
- **[DevOps Adapter Integration](/integrations/devops-adapter-overview/)** - Integrate with GitHub Issues, Azure DevOps, Linear, Jira for backlog tracking
- **[Backlog Refinement](/bundles/backlog/refinement/)** - AI-assisted template-driven refinement with filtering and DoR checks
- **[DevOps Adapter Integration](integrations/devops-adapter-overview/)** - Integrate with GitHub Issues, Azure DevOps, Linear, Jira for backlog tracking
- **[Backlog Refinement](bundles/backlog/refinement/)** - AI-assisted template-driven refinement with filtering and DoR checks
- **[Specmatic Integration](specmatic-integration.md)** - API contract testing with Specmatic
- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions
- **[Installing Modules](installing-modules.md)** - Install, list, show, search, enable/disable, uninstall, and upgrade modules
- **[Module Marketplace](module-marketplace.md)** - Discovery priority, trust vs origin semantics, and security model
- **[Custom registries](/authoring/custom-registries/)** - Add, list, remove registries; trust levels and priority
- **[Publishing modules](/authoring/publishing-modules/)** - Package, sign, and publish modules to a registry
- **[Custom registries](authoring/custom-registries/)** - Add, list, remove registries; trust levels and priority
- **[Publishing modules](authoring/publishing-modules/)** - Package, sign, and publish modules to a registry
- **[Module Signing and Key Rotation](module-signing-and-key-rotation.md)** - Public key placement, signing workflow, CI verification, rotation, and revocation runbook
- **[Competitive Analysis](competitive-analysis.md)** - How SpecFact compares to other tools
- **[Operational Modes](../reference/modes.md)** - CI/CD vs CoPilot modes
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ai-ide-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Examples:
```bash
specfact backlog ceremony refinement github --preview --labels feature
specfact code review run src --scope changed --no-tests
specfact project sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
specfact sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
```

These commands are the source of truth. The IDE should support them, not replace them.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/brownfield-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Use this when backlog items must be refined before the modernization work is syn
```bash
specfact backlog ceremony refinement github --preview --labels feature
specfact backlog verify-readiness --adapter github --project-id owner/repo --target-items 123
specfact project sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
specfact sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
```

Outcome: backlog items are standardized before they drive bundle changes.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/brownfield-modernization.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Use this to identify where the codebase already has contract signals and where m
## 4. Sync or export project state when outside tools are involved

```bash
specfact project sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
specfact sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
```

Use the bridge layer when you need to exchange bundle state with GitHub, Azure DevOps, OpenSpec, or another supported adapter.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/command-chains.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Related: [Brownfield modernization](/guides/brownfield-modernization/)
```bash
specfact backlog ceremony refinement github --preview --labels feature
specfact backlog verify-readiness --adapter github --project-id owner/repo --target-items 123
specfact project sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
specfact sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
```

Use this chain when backlog items must be standardized and readiness-checked before you export or sync them into project artifacts.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/common-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cross-module-chains.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ specfact init ide --repo . --ide cursor
```bash
specfact backlog ceremony refinement github --preview --labels feature
specfact backlog verify-readiness --adapter github --project-id owner/repo --target-items 123
specfact project sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
specfact sync bridge --adapter github --mode export-only --repo . --bundle legacy-api
```

Use this chain when work starts in an external backlog tool and must be cleaned up before it becomes a SpecFact project artifact.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/dual-stack-enrichment.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ide-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
19 changes: 15 additions & 4 deletions docs/guides/integrations-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ SpecFact CLI integrations fall into four main categories:

**What it provides**:

- ✅ Interactive slash commands (`/speckit.specify`, `/speckit.plan`) with AI assistance
- ✅ Rapid prototyping workflow: spec → plan → tasks → code
- ✅ Interactive slash commands (`/constitution`, `/specify`, `/clarify`, `/plan`, `/tasks`, `/analyze`, `/implement`)
- ✅ Rapid prototyping workflow: constitutionspecify → clarify → plan → tasks → analyze → implement
- ✅ Constitution and planning for new features
- ✅ IDE integration with CoPilot chat
- ✅ IDE integration with GitHub Copilot chat and other supported agents
- ✅ Bridge export from Spec-Kit feature folders into OpenSpec change proposals with `specfact sync bridge --adapter speckit --mode change-proposal`

**When to use**:

Expand All @@ -52,6 +53,16 @@ SpecFact CLI integrations fall into four main categories:

**Key difference**: Spec-Kit focuses on **new feature authoring**, while SpecFact CLI focuses on **brownfield code modernization**.

**Bridge workflow examples**:

```bash
# Convert one Spec-Kit feature into an OpenSpec change proposal
specfact sync bridge --adapter speckit --repo . --mode change-proposal --feature 001-auth-sync

# Convert every untracked Spec-Kit feature into OpenSpec changes
specfact sync bridge --adapter speckit --repo . --mode change-proposal --all
```

**See also**: [Spec-Kit Journey Guide](./speckit-journey.md)

---
Expand Down Expand Up @@ -306,7 +317,7 @@ Start: What do you need?

| Integration | Primary Use Case | Key Command | Documentation |
|------------|------------------|-------------|---------------|
| **Spec-Kit** | Interactive spec authoring for new features | `/speckit.specify` | [Spec-Kit Journey](./speckit-journey.md) |
| **Spec-Kit** | Interactive spec authoring for new features | `/specify` | [Spec-Kit Journey](./speckit-journey.md) |
| **OpenSpec** | Specification anchoring and change tracking | `openspec validate` | [OpenSpec Journey](./openspec-journey.md) |
| **Specmatic** | API contract testing and validation | `spec validate` | [Specmatic Integration](./specmatic-integration.md) |
| **Sidecar Validation** 🆕 | Validate external codebases without modifying source | `validate sidecar init/run` | [Sidecar Validation](/bundles/codebase/sidecar-validation/) |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/migration-cli-reorganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use the current mounted entrypoints instead:
When you need exact syntax, verify against live help in the current release, for example:

```bash
specfact project sync bridge --help
specfact sync bridge --help
specfact code repro --help
specfact code validate sidecar --help
specfact spec validate --help
Expand Down
Loading
Loading