UNPKG

@stillrivercode/agentic-workflow-template

Version:

NPM package to create AI-powered GitHub workflow automation projects

129 lines (90 loc) 4.91 kB
# Gemini Project Context You are working with an AI-powered development workflow template. ## Table of Contents - [Key Concepts](#key-concepts) - [Architecture Context](#architecture-context) - [Common Commands](#common-commands) - [Workflow Context](#workflow-context) - [Cross-References](#cross-references) ## Key Concepts - **AI Tasks**: Issues labeled 'ai-task' trigger automated implementation - **OpenRouter**: All AI operations use OpenRouter API (not direct CLI) - **IDK Integration**: Uses IDK (Information Dense Keywords) for consistent AI command vocabulary ## Architecture Context ### Technology Stack - **Platform**: GitHub Actions with OpenRouter API integration - **AI Models**: Multi-model support (Claude, Gemini, GPT-4, Llama via OpenRouter) - **Automation**: Bash scripts with Python utilities for AI workflow orchestration - **Version Control**: Git with automated semantic versioning - **Package Management**: npm with pyproject.toml for Python dependencies ### Coding Conventions - **Shell Scripts**: Use bash with proper error handling (`set -euo pipefail`) - **Python**: Follow PEP 8 standards with pyproject.toml configuration - **Documentation**: Markdown with consistent formatting and anchor links - **Security**: Never commit secrets, use repository secrets for API keys - **Branching**: Always create feature branches, never work directly on main ### Architectural Patterns - **Event-Driven**: GitHub Actions workflows triggered by labels and events - **Microservices**: Modular scripts in `scripts/` and `dev-scripts/` with shared libraries - **Template-Based**: Reusable document templates with IDK command integration - **Cost-Controlled**: Built-in API usage monitoring and circuit breakers ## AI Development Workflow > **📋 Complete Workflow Guide**: See [docs/AI.md](docs/AI.md) for IDK command vocabulary and [docs/ai-workflow-guide.md](docs/ai-workflow-guide.md) for workflow instructions. ### IDK Command Categories **Core Commands**: SELECT, CREATE, DELETE, FIX **Development**: analyze this, debug this, optimize this **Documentation**: document this, explain this, research this **Quality Assurance**: test this, review this **Workflow**: plan this, spec this **Git Operations**: gh, commit, push, pr, comment ### Recommended Workflow 1. **Start with Research**: `analyze this` to understand the problem space 2. **Update Roadmap**: `plan this` to plan your features 3. **Create Specifications**: `spec this` for detailed technical specs 4. **Implement with AI**: Create implementation issues with the `ai-task` label ### Command Chaining Examples ```bash # Sequential workflow "analyze this authentication system then spec this improved version then plan this implementation" # Parallel operations "test this user service and document this API endpoint" # Complex workflow "debug this performance issue then optimize this query then test this solution" ``` ### Project-Specific Usage ```bash # Step 1: Research & Analysis npx @stillrivercode/information-dense-keywords "analyze this --issue 123" npx @stillrivercode/information-dense-keywords "research this --issue 123 --generate-docs" # Step 2: Plan Features npx @stillrivercode/information-dense-keywords "plan this --input 'New Feature A, Refactor B'" npx @stillrivercode/information-dense-keywords "plan this --research-doc research.md" # Step 3: Create Technical Specs npx @stillrivercode/information-dense-keywords "spec this --title 'Technical specification for user login'" ``` - Standard git operations and file management ## Workflow Context When working locally, you help developers with: - Code generation and review - Test creation - Documentation - Bug fixing Remember: GitHub Actions use OpenRouter, not local CLI tools. ## Cross-References ### Related Documentation - [docs/ai-workflow-guide.md](docs/ai-workflow-guide.md) - Complete AI development workflow guide - [CLAUDE.md](CLAUDE.md) - Claude-specific context and instructions - [README.md](README.md) - Main project documentation and setup guide - [README-dev.md](README-dev.md) - Template development guide - [docs/simplified-architecture.md](docs/simplified-architecture.md) - Quick start guide - [dev-docs/architecture.md](dev-docs/architecture.md) - Advanced setup documentation ### Workflow Documentation - [.github/workflows/](/.github/workflows/) - GitHub Actions workflow definitions - [scripts/](scripts/) - Automation scripts and utilities - [dev-scripts/](dev-scripts/) - Scripts for template development - [IDK Commands](https://github.com/stillrivercode/idk) - Cross-AI compatible command vocabulary - [specs/](specs/) - Technical specification documents ### Key Configuration Files - [pyproject.toml](pyproject.toml) - Python project configuration - [package.json](package.json) - Node.js dependencies and scripts - [.pre-commit-config.yaml](.pre-commit-config.yaml) - Code quality hooks