codexspec 0.1.0__tar.gz

codexspec-0.1.0/.gitignore

@@ -0,0 +1,286 @@
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+/spec-kit/
+
+# Project specific
+.codexspec/
+!.codexspec/.gitkeep
+
+
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos,windows,linux,python,powershell,git
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,linux,python,powershell,git
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### PowerShell ###
+# Exclude packaged modules
+*.zip
+
+# Exclude .NET assemblies from source
+*.dll
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,python,powershell,git

codexspec-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CodexSpec Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codexspec-0.1.0/PKG-INFO

@@ -0,0 +1,384 @@
+Metadata-Version: 2.4
+Name: codexspec
+Version: 0.1.0
+Summary: CodexSpec - A Spec-Driven Development (SDD) toolkit for Claude Code
+Project-URL: Homepage, https://github.com/Zts0hg/codexspec
+Project-URL: Repository, https://github.com/Zts0hg/codexspec
+Project-URL: Issues, https://github.com/Zts0hg/codexspec/issues
+Author: CodexSpec Team
+License: MIT
+License-File: LICENSE
+Keywords: ai,claude,cli,sdd,spec-driven-development
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# CodexSpec
+
+**A Spec-Driven Development (SDD) toolkit for Claude Code**
+
+CodexSpec is a toolkit that helps you build high-quality software using a structured, specification-driven approach. It flips the script on traditional development by making specifications executable artifacts that directly guide implementation.
+
+## Features
+
+- **Structured Workflow**: Clear commands for each phase of development
+- **Claude Code Integration**: Native slash commands for Claude Code
+- **Constitution-Based**: Project principles guide all decisions
+- **Specification-First**: Define what and why before how
+- **Plan-Driven**: Technical choices come after requirements
+- **Task-Oriented**: Break down implementation into actionable tasks
+- **Quality Assurance**: Built-in review, analysis, and checklist commands
+- **Cross-Platform**: Support for both Bash and PowerShell scripts
+- **Extensible**: Plugin architecture for custom commands
+
+## Installation
+
+### Option 1: Persistent Installation (Recommended)
+
+Install once and use everywhere:
+
+```bash
+uv tool install codexspec --from git+https://github.com/Zts0hg/codexspec.git
+```
+
+Then use the tool directly:
+
+```bash
+# Create new project
+codexspec init my-project
+
+# Initialize in existing project
+codexspec init . --ai claude
+# or
+codexspec init --here --ai claude
+
+# Check installed tools
+codexspec check
+
+# View version
+codexspec version
+```
+
+To upgrade:
+
+```bash
+uv tool install codexspec --force --from git+https://github.com/Zts0hg/codexspec.git
+```
+
+### Option 2: One-time Usage
+
+Run directly without installing:
+
+```bash
+uvx --from git+https://github.com/Zts0hg/codexspec.git codexspec init my-project
+```
+
+## Quick Start
+
+### 1. Initialize a Project
+
+```bash
+# Create a new project
+codexspec init my-awesome-project
+
+# Or initialize in current directory
+codexspec init . --ai claude
+```
+
+### 2. Establish Project Principles
+
+Launch Claude Code in the project directory:
+
+```bash
+cd my-awesome-project
+claude
+```
+
+Use the `/codexspec.constitution` command to create your project's governing principles:
+
+```
+/codexspec.constitution Create principles focused on code quality, testing standards, and clean architecture
+```
+
+### 3. Create a Specification
+
+Use `/codexspec.specify` to define what you want to build:
+
+```
+/codexspec.specify Build a task management application with the following features: create tasks, assign to users, set due dates, and track progress
+```
+
+### 4. Clarify Requirements (Optional but Recommended)
+
+Use `/codexspec.clarify` to resolve ambiguities before planning:
+
+```
+/codexspec.clarify
+```
+
+### 5. Create a Technical Plan
+
+Use `/codexspec.spec-to-plan` to define how to implement it:
+
+```
+/codexspec.spec-to-plan Use Python with FastAPI for the backend, PostgreSQL for the database, and React for the frontend
+```
+
+### 6. Generate Tasks
+
+Use `/codexspec.plan-to-tasks` to break down the plan:
+
+```
+/codexspec.plan-to-tasks
+```
+
+### 7. Analyze (Optional but Recommended)
+
+Use `/codexspec.analyze` for cross-artifact consistency check:
+
+```
+/codexspec.analyze
+```
+
+### 8. Implement
+
+Use `/codexspec.implement-tasks` to execute the implementation:
+
+```
+/codexspec.implement-tasks
+```
+
+## Available Commands
+
+### CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `codexspec init` | Initialize a new CodexSpec project |
+| `codexspec check` | Check for installed tools |
+| `codexspec version` | Display version information |
+
+### `codexspec init` Options
+
+| Option | Description |
+|--------|-------------|
+| `PROJECT_NAME` | Name for your new project directory |
+| `--here`, `-h` | Initialize in current directory |
+| `--ai`, `-a` | AI assistant to use (default: claude) |
+| `--force`, `-f` | Force overwrite existing files |
+| `--no-git` | Skip git initialization |
+| `--debug`, `-d` | Enable debug output |
+
+### Slash Commands
+
+After initialization, these slash commands are available in Claude Code:
+
+#### Core Commands
+
+| Command | Description |
+|---------|-------------|
+| `/codexspec.constitution` | Create or update project governing principles |
+| `/codexspec.specify` | Define what you want to build (requirements) |
+| `/codexspec.generate-spec` | Generate detailed specification from requirements |
+| `/codexspec.spec-to-plan` | Convert specification to technical plan |
+| `/codexspec.plan-to-tasks` | Break down plan into actionable tasks |
+| `/codexspec.implement-tasks` | Execute tasks according to breakdown |
+
+#### Review Commands
+
+| Command | Description |
+|---------|-------------|
+| `/codexspec.review-spec` | Review specification for completeness |
+| `/codexspec.review-plan` | Review technical plan for feasibility |
+| `/codexspec.review-tasks` | Review task breakdown for completeness |
+
+#### Enhanced Commands
+
+| Command | Description |
+|---------|-------------|
+| `/codexspec.clarify` | Clarify underspecified areas before planning |
+| `/codexspec.analyze` | Cross-artifact consistency analysis |
+| `/codexspec.checklist` | Generate quality checklists for requirements |
+| `/codexspec.tasks-to-issues` | Convert tasks to GitHub issues |
+
+## Workflow Overview
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                    CodexSpec Workflow                        │
+├─────────────────────────────────────────────────────────────┤
+│                                                              │
+│  1. Constitution  ──►  Define project principles             │
+│         │                                                    │
+│         ▼                                                    │
+│  2. Specify  ───────►  Create feature specification          │
+│         │                                                    │
+│         ▼                                                    │
+│  3. Clarify  ───────►  Resolve ambiguities (optional)        │
+│         │                                                    │
+│         ▼                                                    │
+│  4. Review Spec  ───►  Validate specification                │
+│         │                                                    │
+│         ▼                                                    │
+│  5. Spec to Plan  ──►  Create technical plan                 │
+│         │                                                    │
+│         ▼                                                    │
+│  6. Review Plan  ───►  Validate technical plan               │
+│         │                                                    │
+│         ▼                                                    │
+│  7. Plan to Tasks  ─►  Generate task breakdown               │
+│         │                                                    │
+│         ▼                                                    │
+│  8. Analyze  ───────►  Cross-artifact consistency (optional) │
+│         │                                                    │
+│         ▼                                                    │
+│  9. Review Tasks  ──►  Validate task breakdown               │
+│         │                                                    │
+│         ▼                                                    │
+│  10. Implement  ─────►  Execute implementation               │
+│                                                              │
+└─────────────────────────────────────────────────────────────┘
+```
+
+## Project Structure
+
+After initialization, your project will have this structure:
+
+```
+my-project/
+├── .codexspec/
+│   ├── memory/
+│   │   └── constitution.md    # Project governing principles
+│   ├── specs/
+│   │   └── {feature-id}/
+│   │       ├── spec.md        # Feature specification
+│   │       ├── plan.md        # Technical plan
+│   │       ├── tasks.md       # Task breakdown
+│   │       └── checklists/    # Quality checklists
+│   ├── templates/             # Custom templates
+│   ├── scripts/               # Helper scripts
+│   │   ├── bash/              # Bash scripts
+│   │   └── powershell/        # PowerShell scripts
+│   └── extensions/            # Custom extensions
+├── .claude/
+│   └── commands/              # Slash commands for Claude Code
+└── CLAUDE.md                  # Context for Claude Code
+```
+
+## Extension System
+
+CodexSpec supports a plugin architecture for adding custom commands:
+
+### Extension Structure
+
+```
+my-extension/
+├── extension.yml          # Extension manifest
+├── commands/              # Custom slash commands
+│   └── command.md
+└── README.md
+```
+
+### Creating Extensions
+
+1. Copy the template from `extensions/template/`
+2. Modify `extension.yml` with your extension details
+3. Add your custom commands in `commands/`
+4. Test locally and publish
+
+See `extensions/EXTENSION-DEVELOPMENT-GUIDE.md` for details.
+
+## Development
+
+### Prerequisites
+
+- Python 3.11+
+- uv package manager
+- Git
+
+### Local Development
+
+```bash
+# Clone the repository
+git clone https://github.com/Zts0hg/codexspec.git
+cd codexspec
+
+# Install development dependencies
+uv sync --dev
+
+# Run locally
+uv run codexspec --help
+
+# Run tests
+uv run pytest
+
+# Lint code
+uv run ruff check src/
+```
+
+### Building
+
+```bash
+# Build the package
+uv build
+```
+
+## Comparison with spec-kit
+
+CodexSpec is inspired by GitHub's spec-kit but with some key differences:
+
+| Feature | spec-kit | CodexSpec |
+|---------|----------|-----------|
+| Core Philosophy | Spec-driven development | Spec-driven development |
+| CLI Name | `specify` | `codexspec` |
+| Primary AI | Multi-agent support | Claude Code focused |
+| Command Prefix | `/speckit.*` | `/codexspec.*` |
+| Workflow | specify → plan → tasks → implement | constitution → specify → clarify → plan → tasks → analyze → implement |
+| Review Steps | Optional | Built-in review commands |
+| Clarify Command | Yes | Yes |
+| Analyze Command | Yes | Yes |
+| Checklist Command | Yes | Yes |
+| Extension System | Yes | Yes |
+| PowerShell Scripts | Yes | Yes |
+
+## Philosophy
+
+CodexSpec follows these core principles:
+
+1. **Intent-driven development**: Specifications define the "what" before the "how"
+2. **Rich specification creation**: Use guardrails and organizational principles
+3. **Multi-step refinement**: Rather than one-shot code generation
+4. **Heavy reliance on AI**: Leverage AI for specification interpretation
+5. **Review-oriented**: Validate each artifact before moving forward
+6. **Quality-first**: Built-in checklists and analysis for requirements quality
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines before submitting a pull request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Acknowledgements
+
+- Inspired by [GitHub spec-kit](https://github.com/github/spec-kit)
+- Built for [Claude Code](https://claude.ai/code)