Skip to main content

Installer for GSI-Protocol workflow commands (Claude Code & Codex)

Project description

GSI-Protocol

Specification-Driven Development (SDD) Workflow for AI-powered Development

License: MIT Python Version Version

Language: English | 繁體中文

GSI-Protocol is an automated Specification-Driven Development (SDD) workflow system that transforms user requirements into production-ready code through a structured 4-phase process: Specification → Architecture → Implementation → Verification.

Features

  • Multi-Platform Support: Works with Claude Code, Codex (OpenAI), and GitHub Copilot
  • Language Agnostic: Architecture design independent of programming language
  • Automated Workflow: Execute complete development cycle with a single command
  • BDD Integration: Built-in support for Gherkin specifications
  • Project-Aware: Automatically detects and adapts to your project's tech stack
  • Role-Based Phases: PM → Architect → Engineer → QA workflow

📚 Learn More

New to GSI-Protocol? Start here:

Quick Start

Installation

Install using uvx (recommended):

uvx --from gsi-protocol-installer gsi-install

Or using pipx:

pipx run gsi-protocol-installer

The installer will guide you through:

  1. Selecting AI platform(s) (Claude Code, Codex, GitHub Copilot)
  2. Choosing installation type (global or project-specific)
  3. Installing workflow commands

Basic Usage

Automatic Mode (Recommended)

Execute the complete 4-phase workflow automatically:

# For Claude Code / Codex
/sdd-auto <your requirement>

# For GitHub Copilot
@workspace /sdd-auto <your requirement>

Example:

/sdd-auto Add user authentication with email and password

Manual Mode

For more control over each phase:

  1. Generate Specification (PM Phase)

    /sdd-spec <requirement>
    
  2. Design Architecture (Architect Phase)

    /sdd-arch <feature_file_path>
    
  3. Implement Code (Engineer Phase)

    /sdd-impl <feature_file_path>
    
  4. Verify Implementation (QA Phase)

    /sdd-verify <feature_file_path>
    

Workflow Overview

The GSI-Protocol follows a structured 4-phase process:

User Requirement
      ↓
[Phase 1: Specification (PM)]
   → .gsi/{feature}/PRD.md (business behaviour)
   → .gsi/{feature}/{feature}.feature (SpecBridge HTTP contract)
      ↓
[Phase 2: Architecture (Architect)]
   → .gsi/{feature}/architecture.md
      ↓
[Phase 3: Implementation (Engineer)]
   → Source code + unit tests (TDD)
      ↓
[Phase 4: Verification (QA)]
   → specbridge verify + unit tests
   → .gsi/{feature}/conclusion.md

Learn the methodology: Read our GSI Theory & Methodology guide to understand how Gherkin (specification), Structure (architecture), and Implement (code) work together.

Available Commands

Command Description Phase
/sdd-auto Execute complete workflow automatically All
/sdd-spec Generate PRD + SpecBridge contract from requirements 1
/sdd-arch Design architecture from specification 2
/sdd-impl Implement code + unit tests (TDD) 3
/sdd-verify Verify via specbridge + unit tests 4

Output Structure

After running the workflow, your project will have:

project_root/
├── .gsi/{feature_name}/
│   ├── PRD.md                          # Business behaviour spec
│   ├── {feature_name}.feature          # SpecBridge HTTP contract
│   ├── architecture.md                 # Architecture design
│   └── conclusion.md                   # Verification report
└── {your_project_structure}/
    ├── {model_files}                   # Generated models
    ├── {service_files}                 # Generated services
    └── {unit_test_files}               # TDD-produced tests

Platform-Specific Usage

Claude Code

Commands are available directly in Claude Code CLI:

/sdd-auto <requirement>
/sdd-spec <requirement>

Codex (OpenAI)

Use prompts with argument placeholders:

/sdd-auto <requirement>

GitHub Copilot

Prefix commands with @workspace:

@workspace /sdd-auto <requirement>
@workspace /sdd-spec <requirement>

Requirements

  • Python 3.10 or higher
  • Node.js 18 or higher
  • Git
  • One of the supported AI platforms:
    • Claude Code CLI
    • Codex (OpenAI)
    • GitHub Copilot

SpecBridge (Required)

GSI-Protocol integrates SpecBridge in the Specification (/sdd-spec) and Verification (/sdd-verify) phases. SpecBridge is a contract testing CLI that validates live HTTP API behavior against Gherkin feature files.

Install it globally before using GSI-Protocol:

npm install -g @ksz54213/specbridge

Verify installation:

specbridge --version

Documentation

For detailed documentation, see the docs directory:

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

James Hsueh - asdfg55887@gmail.com

Links

Changelog

See version history and updates in the project repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gsi_protocol_installer-1.4.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gsi_protocol_installer-1.4.1-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file gsi_protocol_installer-1.4.1.tar.gz.

File metadata

  • Download URL: gsi_protocol_installer-1.4.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gsi_protocol_installer-1.4.1.tar.gz
Algorithm Hash digest
SHA256 844b74ca45bd1bcaad747a0de7633b592782c0b049a4a54abf5da1c754e60b10
MD5 f5c9766e6cd5b586a600f2cd6f93ee21
BLAKE2b-256 5ec4143203425040673b2f00248500f8b0fdcce34fcab217239ec2380ae22273

See more details on using hashes here.

Provenance

The following attestation bundles were made for gsi_protocol_installer-1.4.1.tar.gz:

Publisher: publish-to-pypi.yml on CodeMachine0121/GSI-Protocol

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gsi_protocol_installer-1.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gsi_protocol_installer-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cffb445f3f709a53c144b8ea6546afc46a6b50a2ec1062524424a1f94e6f88e6
MD5 d8e6731fb9d70ec94471f0b8b2ccb3ef
BLAKE2b-256 f3c374ab8f2a434990129f65cbdcfcab69d09e4006937f223b6a311c3bd075fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for gsi_protocol_installer-1.4.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on CodeMachine0121/GSI-Protocol

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page