mirror of
https://github.com/BillyOutlast/oboromi.git
synced 2026-07-01 19:54:43 -04:00
chore: init gsd
This commit is contained in:
John Doe
@@ -0,0 +1,58 @@
|
||||
# Spec Kitty Configuration and Templates
|
||||
# These are internal directories that shouldn't be scanned by AI assistants
|
||||
|
||||
# Template directories (not working code)
|
||||
.kittify/templates/
|
||||
.kittify/missions/
|
||||
.kittify/scripts/
|
||||
|
||||
# Agent command directories (generated from templates, not source)
|
||||
.claude/
|
||||
.codex/
|
||||
.gemini/
|
||||
.cursor/
|
||||
.qwen/
|
||||
.opencode/
|
||||
.windsurf/
|
||||
.kilocode/
|
||||
.augment/
|
||||
.roo/
|
||||
.amazonq/
|
||||
.github/copilot/
|
||||
|
||||
# Git metadata
|
||||
.git/
|
||||
|
||||
# Build artifacts and caches
|
||||
__pycache__/
|
||||
*.pyc
|
||||
*.pyo
|
||||
.pytest_cache/
|
||||
.coverage
|
||||
htmlcov/
|
||||
node_modules/
|
||||
dist/
|
||||
build/
|
||||
*.egg-info/
|
||||
|
||||
# Virtual environments
|
||||
.venv/
|
||||
venv/
|
||||
env/
|
||||
|
||||
# OS-specific files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
desktop.ini
|
||||
|
||||
# IDE directories
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Logs and databases
|
||||
*.log
|
||||
*.db
|
||||
*.sqlite
|
||||
@@ -0,0 +1 @@
|
||||
kitty-specs/**/status.events.jsonl merge=spec-kitty-event-log
|
||||
+59
@@ -4,3 +4,62 @@
|
||||
.vscode/
|
||||
rad/
|
||||
research/
|
||||
|
||||
# Added by Spec Kitty CLI (auto-managed)
|
||||
.claude/
|
||||
.codex/
|
||||
.vibe/
|
||||
.opencode/
|
||||
.windsurf/
|
||||
.gemini/
|
||||
.cursor/
|
||||
.qwen/
|
||||
.kilocode/
|
||||
.augment/
|
||||
.roo/
|
||||
.amazonq/
|
||||
.kiro/
|
||||
.agent/
|
||||
.github/copilot/
|
||||
.kittify/.dashboard
|
||||
.kittify/charter/context-state.json
|
||||
.kittify/charter/directives.yaml
|
||||
.kittify/charter/governance.yaml
|
||||
.kittify/charter/metadata.yaml
|
||||
.kittify/charter/references.yaml
|
||||
.kittify/dossiers/
|
||||
.kittify/events/
|
||||
.kittify/merge-state.json
|
||||
.kittify/missions/__pycache__/
|
||||
.kittify/runtime/
|
||||
.kittify/workspaces/
|
||||
|
||||
# ── GSD baseline (auto-generated) ──
|
||||
.gsd
|
||||
.gsd-id
|
||||
.mcp.json
|
||||
.bg-shell/
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.idea/
|
||||
*.code-workspace
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
node_modules/
|
||||
.next/
|
||||
dist/
|
||||
build/
|
||||
__pycache__/
|
||||
*.pyc
|
||||
.venv/
|
||||
venv/
|
||||
target/
|
||||
vendor/
|
||||
*.log
|
||||
coverage/
|
||||
.cache/
|
||||
tmp/
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
vcs:
|
||||
type: git
|
||||
agents:
|
||||
available:
|
||||
- opencode
|
||||
auto_commit: true
|
||||
@@ -0,0 +1,245 @@
|
||||
# PowerShell Syntax Guide for AI Agents
|
||||
|
||||
**⚠️ READ THIS if you are working in a PowerShell environment**
|
||||
|
||||
This guide helps AI agents use correct PowerShell syntax when working with spec-kitty workflows.
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference: Bash vs PowerShell
|
||||
|
||||
| Task | ❌ Bash (WRONG) | ✅ PowerShell (CORRECT) |
|
||||
|------|-----------------|-------------------------|
|
||||
| **Command chaining** | `cmd1 && cmd2` | `cmd1; cmd2` |
|
||||
| **Parameter flags** | `--json --paths-only` | `-Json -PathsOnly` |
|
||||
| **Script path** | `./scripts/bash/script.sh` | `..\scripts\powershell\Script.ps1` |
|
||||
| **Environment variable** | `$VAR_NAME` | `$env:VAR_NAME` |
|
||||
| **Current directory** | `pwd` | `Get-Location` (or `pwd` alias) |
|
||||
| **List files** | `ls -la` | `Get-ChildItem` (or `ls` alias) |
|
||||
| **File exists check** | `[ -f file.txt ]` | `Test-Path file.txt` |
|
||||
| **Directory separator** | `/path/to/file` | `\path\to\file` |
|
||||
| **Home directory** | `~/projects` | `$HOME\projects` |
|
||||
|
||||
---
|
||||
|
||||
## Location Verification (PowerShell)
|
||||
|
||||
**Check your current location:**
|
||||
|
||||
```powershell
|
||||
Get-Location
|
||||
git branch --show-current
|
||||
```
|
||||
|
||||
**Expected for mission worktrees:**
|
||||
|
||||
- Location: `C:\Users\...\project\.worktrees\001-mission-name`
|
||||
- Branch: `001-mission-name` (NOT `main`)
|
||||
|
||||
---
|
||||
|
||||
## Running Spec-Kitty Commands (PowerShell)
|
||||
|
||||
### Using the spec-kitty CLI
|
||||
|
||||
Spec-kitty uses a Python CLI that works across all platforms:
|
||||
|
||||
**Common commands:**
|
||||
|
||||
- `spec-kitty agent mission create-mission <slug>` - Create a new feature
|
||||
- `spec-kitty verify-setup` - Check environment and paths
|
||||
- `spec-kitty agent workflow implement <WPID> --agent <name>` - Start implementing a work package
|
||||
- `spec-kitty agent workflow review <WPID> --agent <name>` - Start reviewing a work package
|
||||
- `spec-kitty agent tasks move-task <WPID> --to for_review` - Complete implementation (move to review)
|
||||
- `spec-kitty merge` - Merge completed mission
|
||||
|
||||
### Parameter Naming Convention
|
||||
|
||||
PowerShell uses **PascalCase** with leading dash:
|
||||
|
||||
- `-Json` (not `--json`)
|
||||
- `-MissionName` (not `--mission-name`)
|
||||
- `-IncludeTasks` (not `--include-tasks`)
|
||||
- `-RequireTasks` (not `--require-tasks`)
|
||||
|
||||
### Examples
|
||||
|
||||
**Create feature:**
|
||||
|
||||
```powershell
|
||||
.\.kittify\scripts\powershell\Create-NewMission.ps1 `
|
||||
-MissionName "User Authentication" `
|
||||
-FeatureDescription "Add login and registration"
|
||||
```
|
||||
|
||||
**Check prerequisites:**
|
||||
|
||||
```powershell
|
||||
.\.kittify\scripts\powershell\check-prerequisites.ps1 -Json -IncludeTasks
|
||||
```
|
||||
|
||||
**Move task to review (after implementation):**
|
||||
|
||||
```powershell
|
||||
# Using the CLI (recommended):
|
||||
spec-kitty agent tasks move-task WP01 --to for_review --note "Ready for review"
|
||||
|
||||
# Or using PowerShell script:
|
||||
.\.kittify\scripts\powershell\Move-TaskToLane.ps1 `
|
||||
-Feature "001-auth" `
|
||||
-TaskId "WP01" `
|
||||
-Lane "for_review" `
|
||||
-ShellPid $PID `
|
||||
-Agent "claude"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
### ❌ Don't Use Bash Operators
|
||||
|
||||
```powershell
|
||||
# WRONG:
|
||||
cd worktrees && pwd
|
||||
|
||||
# CORRECT:
|
||||
cd worktrees; Get-Location
|
||||
```
|
||||
|
||||
### ❌ Don't Use Bash-Style Parameters
|
||||
|
||||
```powershell
|
||||
# WRONG:
|
||||
.\check-prerequisites.ps1 --json --require-tasks
|
||||
|
||||
# CORRECT:
|
||||
.\check-prerequisites.ps1 -Json -RequireTasks
|
||||
```
|
||||
|
||||
### Path Separators in PowerShell
|
||||
|
||||
PowerShell on Windows uses backslashes for native paths:
|
||||
|
||||
```powershell
|
||||
# WRONG (Unix-style paths on Windows):
|
||||
cd ./.kittify/memory
|
||||
|
||||
# CORRECT (Windows-style paths):
|
||||
cd .\.kittify\memory
|
||||
```
|
||||
|
||||
Note: Git commands work with forward slashes, but native PowerShell file operations expect backslashes. The spec-kitty CLI handles this automatically.
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables
|
||||
|
||||
**Setting variables:**
|
||||
|
||||
```powershell
|
||||
$env:SPEC_KITTY_TEMPLATE_ROOT = "C:\path\to\spec-kitty"
|
||||
```
|
||||
|
||||
**Reading variables:**
|
||||
|
||||
```powershell
|
||||
echo $env:SPEC_KITTY_TEMPLATE_ROOT
|
||||
```
|
||||
|
||||
**Checking if set:**
|
||||
|
||||
```powershell
|
||||
if ($env:SPEC_KITTY_TEMPLATE_ROOT) {
|
||||
Write-Host "Variable is set"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## File Operations
|
||||
|
||||
**Check if file exists:**
|
||||
|
||||
```powershell
|
||||
if (Test-Path "spec.md") {
|
||||
Write-Host "Spec exists"
|
||||
}
|
||||
```
|
||||
|
||||
**Read file:**
|
||||
|
||||
```powershell
|
||||
$content = Get-Content "spec.md" -Raw
|
||||
```
|
||||
|
||||
**Create directory:**
|
||||
|
||||
```powershell
|
||||
New-Item -ItemType Directory -Path "tasks\planned" -Force
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow Tips
|
||||
|
||||
1. **Always use full parameter names** in scripts (not abbreviations)
|
||||
2. **Use semicolons** to chain commands, not `&&` or `||`
|
||||
3. **Backslashes** for local paths, forward slashes OK for git operations
|
||||
4. **$PID** contains current PowerShell process ID (use for --shell-pid)
|
||||
5. **Tab completion** works for parameter names in PowerShell
|
||||
|
||||
---
|
||||
|
||||
## When to Use What
|
||||
|
||||
**Use PowerShell scripts when:**
|
||||
|
||||
- User specified `--script ps` during init
|
||||
- You're in a Windows PowerShell terminal
|
||||
- Templates reference `.ps1` files in frontmatter
|
||||
|
||||
**Use Bash scripts when:**
|
||||
|
||||
- User specified `--script sh` during init
|
||||
- You're in bash/zsh/fish terminal
|
||||
- Templates reference `.sh` files in frontmatter
|
||||
|
||||
**Using spec-kitty commands:**
|
||||
All spec-kitty commands work the same way on PowerShell and Bash:
|
||||
|
||||
```powershell
|
||||
spec-kitty agent workflow implement WP01 --agent claude # Auto-moves to doing
|
||||
spec-kitty agent tasks move-task WP01 --to for_review # Completion step
|
||||
spec-kitty verify-setup
|
||||
spec-kitty dashboard
|
||||
```
|
||||
|
||||
The CLI is cross-platform and handles path differences automatically.
|
||||
|
||||
---
|
||||
|
||||
## Debugging PowerShell Issues
|
||||
|
||||
**Common errors and solutions:**
|
||||
|
||||
1. **"Parameter cannot be found that matches parameter name"**
|
||||
- You used bash-style parameters (`--json`)
|
||||
- Fix: Use PowerShell style (`-Json`)
|
||||
|
||||
2. **"The term '&&' is not recognized"**
|
||||
- You used bash command chaining
|
||||
- Fix: Use semicolon (`;`) instead
|
||||
|
||||
3. **"Cannot find path"**
|
||||
- You used forward slashes in PowerShell path
|
||||
- Fix: Use backslashes (`\`) for local paths
|
||||
|
||||
4. **"Unable to import mission module"**
|
||||
- Python can't find specify_cli package
|
||||
- Check: `pip show spec-kitty-cli`
|
||||
- Fix: Reinstall or check virtual environment
|
||||
|
||||
---
|
||||
|
||||
**For full spec-kitty documentation, see the main templates and README.**
|
||||
@@ -0,0 +1,14 @@
|
||||
# Spec Kitty Project Metadata
|
||||
# Auto-generated by spec-kitty init/upgrade
|
||||
# DO NOT EDIT MANUALLY
|
||||
|
||||
spec_kitty:
|
||||
version: 3.1.8
|
||||
initialized_at: '2026-05-03T10:36:31.275188'
|
||||
last_upgraded_at: null
|
||||
environment:
|
||||
python_version: 3.14.4
|
||||
platform: win32
|
||||
platform_version: Windows-11-10.0.26300-SP0
|
||||
migrations:
|
||||
applied: []
|
||||
Reference in New Issue
Block a user