chore: import upstream snapshot with attribution

2026-07-13 11:57:40 +08:00
commit 923a61929d
462 changed files with 139124 additions and 0 deletions
@@ -0,0 +1,142 @@
+# Contributing to the Integration Catalog
+
+This guide covers adding integrations to both the **built-in** and **community** catalogs.
+
+## Adding a Built-In Integration
+
+Built-in integrations are maintained by the Spec Kit core team and ship with the CLI.
+
+### Checklist
+
+1. **Create the integration subpackage** under `src/specify_cli/integrations/<package_dir>/`
+   — `<package_dir>` matches the integration key when it contains no hyphens (e.g., `gemini`), or replaces hyphens with underscores when it does (e.g., key `cursor-agent` → directory `cursor_agent/`, key `kiro-cli` → directory `kiro_cli/`). Python package names cannot use hyphens.
+2. **Implement the integration class** extending `MarkdownIntegration`, `TomlIntegration`, or `SkillsIntegration`
+3. **Register the integration** in `src/specify_cli/integrations/__init__.py`
+4. **Add tests** under `tests/integrations/test_integration_<package_dir>.py`
+5. **Add a catalog entry** in `integrations/catalog.json`
+6. **Update documentation** in `AGENTS.md` and `README.md`
+
+### Catalog Entry Format
+
+Add your integration under the top-level `integrations` key in `integrations/catalog.json`:
+
+```json
+{
+  "schema_version": "1.0",
+  "integrations": {
+    "my-agent": {
+      "id": "my-agent",
+      "name": "My Agent",
+      "version": "1.0.0",
+      "description": "Integration for My Agent",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    }
+  }
+}
+```
+
+## Adding a Community Integration
+
+Community integrations are contributed by external developers and listed in `integrations/catalog.community.json` for discovery.
+
+### Prerequisites
+
+1. **Working integration** — tested with `specify integration install`
+2. **Public repository** — hosted on GitHub or similar
+3. **`integration.yml` descriptor** — valid descriptor file (see below)
+4. **Documentation** — README with usage instructions
+5. **License** — open source license file
+
+### `integration.yml` Descriptor
+
+Every community integration must include an `integration.yml`:
+
+```yaml
+schema_version: "1.0"
+integration:
+  id: "my-agent"
+  name: "My Agent"
+  version: "1.0.0"
+  description: "Integration for My Agent"
+  author: "your-name"
+  repository: "https://github.com/your-name/speckit-my-agent"
+  license: "MIT"
+requires:
+  speckit_version: ">=0.6.0"
+  tools:
+    - name: "my-agent"
+      version: ">=1.0.0"
+      required: true
+provides:
+  commands:
+    - name: "speckit.specify"
+      file: "templates/speckit.specify.md"
+  scripts:
+    - update-context.sh
+```
+
+### Descriptor Validation Rules
+
+| Field | Rule |
+|-------|------|
+| `schema_version` | Must be `"1.0"` |
+| `integration.id` | Lowercase alphanumeric + hyphens (`^[a-z0-9-]+$`) |
+| `integration.version` | Valid PEP 440 version (parsed with `packaging.version.Version()`) |
+| `requires.speckit_version` | Required field; specify a version constraint such as `>=0.6.0` (current validation checks presence only) |
+| `provides` | Must include at least one command or script |
+| `provides.commands[].name` | String identifier |
+| `provides.commands[].file` | Relative path to template file |
+
+### Submitting to the Community Catalog
+
+1. **Fork** the [spec-kit repository](https://github.com/github/spec-kit)
+2. **Add your entry** under the `integrations` key in `integrations/catalog.community.json`:
+
+```json
+{
+  "schema_version": "1.0",
+  "integrations": {
+    "my-agent": {
+      "id": "my-agent",
+      "name": "My Agent",
+      "version": "1.0.0",
+      "description": "Integration for My Agent",
+      "author": "your-name",
+      "repository": "https://github.com/your-name/speckit-my-agent",
+      "tags": ["cli"]
+    }
+  }
+}
+```
+
+3. **Open a pull request** with:
+   - Your catalog entry
+   - Link to your integration repository
+   - Confirmation that `integration.yml` is valid
+
+### Version Updates
+
+To update your integration version in the catalog:
+
+1. Release a new version of your integration
+2. Open a PR updating the `version` field in `catalog.community.json`
+3. Ensure backward compatibility or document breaking changes
+
+## Upgrade Workflow
+
+The `specify integration upgrade` command supports diff-aware upgrades:
+
+1. **Hash comparison** — the manifest records SHA-256 hashes of all installed files
+2. **Modified file detection** — files changed since installation are flagged
+3. **Safe default** — the upgrade blocks if any installed files were modified since installation
+4. **Forced reinstall** — passing `--force` overwrites modified files with the latest version
+
+```bash
+# Upgrade current integration (blocks if files are modified)
+specify integration upgrade
+
+# Force upgrade (overwrites modified files)
+specify integration upgrade --force
+```
@@ -0,0 +1,129 @@
+# Spec Kit Integration Catalog
+
+The integration catalog enables discovery, versioning, and distribution of AI agent integrations for Spec Kit.
+
+## Catalog Files
+
+### Built-In Catalog (`catalog.json`)
+
+Contains integrations that ship with Spec Kit. These are maintained by the core team and always installable.
+
+### Community Catalog (`catalog.community.json`)
+
+Community-contributed integrations. Listed for discovery only — users install from the source repositories.
+
+## Catalog Configuration
+
+The catalog stack is resolved in this order (first match wins):
+
+1. **Environment variable** — `SPECKIT_INTEGRATION_CATALOG_URL` overrides all catalogs with a single URL
+2. **Project config** — `.specify/integration-catalogs.yml` in the project root
+3. **User config** — `~/.specify/integration-catalogs.yml` in the user home directory
+4. **Built-in defaults** — `catalog.json` + `catalog.community.json`
+
+Example `integration-catalogs.yml`:
+
+```yaml
+catalogs:
+  - url: "https://example.com/my-catalog.json"
+    name: "my-catalog"
+    priority: 1
+    install_allowed: true
+```
+
+## CLI Commands
+
+```bash
+# List built-in integrations (default)
+specify integration list
+
+# Browse full catalog (built-in + community)
+specify integration list --catalog
+
+# Install an integration
+specify integration install copilot
+
+# Upgrade the current integration (diff-aware)
+specify integration upgrade
+
+# Upgrade with force (overwrite modified files)
+specify integration upgrade --force
+```
+
+## Integration Descriptor (`integration.yml`)
+
+Each integration can include an `integration.yml` descriptor that documents its metadata, requirements, and provided commands/scripts:
+
+```yaml
+schema_version: "1.0"
+integration:
+  id: "my-agent"
+  name: "My Agent"
+  version: "1.0.0"
+  description: "Integration for My Agent"
+  author: "my-org"
+  repository: "https://github.com/my-org/speckit-my-agent"
+  license: "MIT"
+requires:
+  speckit_version: ">=0.6.0"
+  tools:
+    - name: "my-agent"
+      version: ">=1.0.0"
+      required: true
+provides:
+  commands:
+    - name: "speckit.specify"
+      file: "templates/speckit.specify.md"
+    - name: "speckit.plan"
+      file: "templates/speckit.plan.md"
+  scripts:
+    - update-context.sh
+    - update-context.ps1
+```
+
+## Catalog Schema
+
+Both catalog files follow the same JSON schema:
+
+```json
+{
+  "schema_version": "1.0",
+  "updated_at": "2026-04-08T00:00:00Z",
+  "catalog_url": "https://...",
+  "integrations": {
+    "my-agent": {
+      "id": "my-agent",
+      "name": "My Agent",
+      "version": "1.0.0",
+      "description": "Integration for My Agent",
+      "author": "my-org",
+      "repository": "https://github.com/my-org/speckit-my-agent",
+      "tags": ["cli"]
+    }
+  }
+}
+```
+
+### Required Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `schema_version` | string | Must be `"1.0"` |
+| `updated_at` | string | ISO 8601 timestamp |
+| `integrations` | object | Map of integration ID → metadata |
+
+### Integration Entry Fields
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `id` | string | Yes | Unique ID (lowercase alphanumeric + hyphens) |
+| `name` | string | Yes | Human-readable display name |
+| `version` | string | Yes | PEP 440 version (e.g., `1.0.0`, `1.0.0a1`) |
+| `description` | string | Yes | One-line description |
+| `author` | string | No | Author name or organization |
+| `repository` | string | No | Source repository URL |
+| `tags` | array | No | Searchable tags (e.g., `["cli", "ide"]`) |
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add integrations to the community catalog.
@@ -0,0 +1,6 @@
+{
+  "schema_version": "1.0",
+  "updated_at": "2026-04-08T00:00:00Z",
+  "catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/integrations/catalog.community.json",
+  "integrations": {}
+}
@@ -0,0 +1,313 @@
+{
+  "schema_version": "1.0",
+  "updated_at": "2026-06-23T00:00:00Z",
+  "catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/integrations/catalog.json",
+  "integrations": {
+    "claude": {
+      "id": "claude",
+      "name": "Claude Code",
+      "version": "1.0.0",
+      "description": "Anthropic Claude Code CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "anthropic"]
+    },
+    "cline": {
+      "id": "cline",
+      "name": "Cline",
+      "version": "1.0.0",
+      "description": "Cline IDE integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide"]
+    },
+    "copilot": {
+      "id": "copilot",
+      "name": "GitHub Copilot",
+      "version": "1.0.0",
+      "description": "GitHub Copilot IDE integration with agent commands and prompt files",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide", "github"]
+    },
+    "gemini": {
+      "id": "gemini",
+      "name": "Gemini CLI",
+      "version": "1.0.0",
+      "description": "Google Gemini CLI integration with TOML command format",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "google"]
+    },
+    "cursor-agent": {
+      "id": "cursor-agent",
+      "name": "Cursor",
+      "version": "1.0.0",
+      "description": "Cursor IDE integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide"]
+    },
+    "amp": {
+      "id": "amp",
+      "name": "Amp",
+      "version": "1.0.0",
+      "description": "Amp CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "codex": {
+      "id": "codex",
+      "name": "Codex CLI",
+      "version": "1.0.0",
+      "description": "Codex CLI skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "skills"]
+    },
+    "devin": {
+      "id": "devin",
+      "name": "Devin for Terminal",
+      "version": "1.0.0",
+      "description": "Devin for Terminal CLI skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "skills"]
+    },
+    "qwen": {
+      "id": "qwen",
+      "name": "Qwen Code",
+      "version": "1.0.0",
+      "description": "Alibaba Qwen Code CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "alibaba"]
+    },
+    "opencode": {
+      "id": "opencode",
+      "name": "opencode",
+      "version": "1.0.0",
+      "description": "opencode CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "firebender": {
+      "id": "firebender",
+      "name": "Firebender",
+      "version": "1.0.0",
+      "description": "Firebender IDE integration for Android Studio / IntelliJ",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide"]
+    },
+    "forge": {
+      "id": "forge",
+      "name": "Forge",
+      "version": "1.0.0",
+      "description": "Forge CLI integration with parameter-based commands",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "kiro-cli": {
+      "id": "kiro-cli",
+      "name": "Kiro CLI",
+      "version": "1.0.0",
+      "description": "Kiro CLI prompt-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "junie": {
+      "id": "junie",
+      "name": "Junie",
+      "version": "1.0.0",
+      "description": "Junie by JetBrains CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "jetbrains"]
+    },
+    "auggie": {
+      "id": "auggie",
+      "name": "Auggie CLI",
+      "version": "1.0.0",
+      "description": "Auggie CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "shai": {
+      "id": "shai",
+      "name": "SHAI",
+      "version": "1.0.0",
+      "description": "SHAI CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "tabnine": {
+      "id": "tabnine",
+      "name": "Tabnine CLI",
+      "version": "1.0.0",
+      "description": "Tabnine CLI integration with TOML command format",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "kilocode": {
+      "id": "kilocode",
+      "name": "Kilo Code",
+      "version": "1.0.0",
+      "description": "Kilo Code IDE workflow integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide"]
+    },
+    "rovodev": {
+      "id": "rovodev",
+      "name": "RovoDev ACLI",
+      "version": "1.0.0",
+      "description": "Atlassian RovoDev integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "atlassian"]
+    },
+    "bob": {
+      "id": "bob",
+      "name": "IBM Bob",
+      "version": "1.0.0",
+      "description": "IBM Bob IDE integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide", "ibm"]
+    },
+    "trae": {
+      "id": "trae",
+      "name": "Trae",
+      "version": "1.0.0",
+      "description": "Trae IDE rules-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide"]
+    },
+    "codebuddy": {
+      "id": "codebuddy",
+      "name": "CodeBuddy",
+      "version": "1.0.0",
+      "description": "CodeBuddy CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "qodercli": {
+      "id": "qodercli",
+      "name": "Qoder CLI",
+      "version": "1.0.0",
+      "description": "Qoder CLI integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "kimi": {
+      "id": "kimi",
+      "name": "Kimi Code",
+      "version": "1.0.0",
+      "description": "Kimi Code CLI skills-based integration by Moonshot AI",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "skills"]
+    },
+    "lingma": {
+      "id": "lingma",
+      "name": "Lingma",
+      "version": "1.0.0",
+      "description": "Lingma IDE skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide", "skills"]
+    },
+    "pi": {
+      "id": "pi",
+      "name": "Pi Coding Agent",
+      "version": "1.0.0",
+      "description": "Pi terminal coding agent prompt-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "omp": {
+      "id": "omp",
+      "name": "Oh My Pi",
+      "version": "1.0.0",
+      "description": "Oh My Pi (omp) terminal coding agent prompt-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "vibe": {
+      "id": "vibe",
+      "name": "Mistral Vibe",
+      "version": "1.0.0",
+      "description": "Mistral Vibe CLI prompt-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "mistral"]
+    },
+    "agy": {
+      "id": "agy",
+      "name": "Antigravity",
+      "version": "1.0.0",
+      "description": "Antigravity IDE skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide", "skills"]
+    },
+    "generic": {
+      "id": "generic",
+      "name": "Generic (bring your own agent)",
+      "version": "1.0.0",
+      "description": "Generic integration for any agent via --integration-options=\"--commands-dir <dir>\"",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["generic"]
+    },
+    "goose": {
+      "id": "goose",
+      "name": "Goose",
+      "version": "1.0.0",
+      "description": "Goose CLI integration with YAML recipe format",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli"]
+    },
+    "hermes": {
+      "id": "hermes",
+      "name": "Hermes Agent",
+      "version": "1.0.0",
+      "description": "Hermes Agent skills-based integration by Nous Research",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "skills"]
+    },
+    "zcode": {
+      "id": "zcode",
+      "name": "ZCode",
+      "version": "1.0.0",
+      "description": "Z.AI ZCode CLI skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["cli", "skills", "z-ai"]
+    },
+    "zed": {
+      "id": "zed",
+      "name": "Zed",
+      "version": "1.0.0",
+      "description": "Zed editor skills-based integration",
+      "author": "spec-kit-core",
+      "repository": "https://github.com/github/spec-kit",
+      "tags": ["ide", "skills"]
+    }
+  }
+}