WIP

Author: habedi

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [habedi]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add logs to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: enhancement
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

ROADMAP.md

@@ -0,0 +1,258 @@
+## Feature Roadmap
+
+This document outlines the roadmap for Binharic, an AI coding assistant blessed by the Omnissiah.
+It includes planned features, improvements, and their current implementation status.
+
+> [!IMPORTANT]
+> This roadmap is a work in progress and is subject to change as we receive guidance from the Machine God.
+
+### 1. Core Agent Capabilities
+
+- **LLM Provider Support**
+    - [x] OpenAI models (GPT-4o, GPT-4o-mini, GPT-5 series)
+    - [x] Anthropic models (Claude 4 Sonnet, Claude 4.5 Sonnet)
+    - [x] Google AI models (Gemini 2.5 Pro, Gemini 2.5 Flash)
+    - [x] Ollama for local model execution
+    - [ ] Support for Azure OpenAI endpoints
+    - [ ] Support for additional model providers (Cohere, Mistral)
+- **Context Management**
+    - [x] Token-based context window management
+    - [x] Automatic context trimming for long conversations
+    - [x] History preservation across sessions
+    - [ ] Intelligent context compression
+    - [ ] Semantic context pruning
+- **Multi-Step Execution**
+    - [x] Multi-step tool calling with retry logic
+    - [x] Transient error handling with exponential backoff
+    - [x] Tool execution confirmation flow
+    - [x] **AI SDK Agent class integration**
+    - [x] **Automatic loop control with stopWhen conditions**
+    - [ ] Parallel tool execution for independent operations
+    - [ ] Automatic tool dependency resolution
+- **Specialized Agents**
+    - [x] **Main Binharic Agent (Tech-Priest persona)**
+    - [x] **Code Analysis Agent**
+    - [x] **Security Audit Agent**
+    - [x] **Test Generation Agent**
+    - [x] **Documentation Agent**
+    - [x] **Refactoring Agent**
+    - [ ] Debug Agent
+    - [ ] Performance Optimization Agent
+    - [ ] Migration Agent
+
+### 2. Tool System
+
+- **File Operations**
+    - [x] Read files with tracking
+    - [x] Create new files
+    - [x] Smart file editing with diff application
+    - [x] List directory contents
+    - [x] File search capabilities
+    - [x] **Integrated with AI SDK Agent class**
+    - [ ] File comparison and diffing
+    - [ ] Bulk file operations
+    - [ ] File watching for changes
+- **Code Intelligence**
+    - [x] TypeScript/JavaScript error detection
+    - [x] Syntax validation
+    - [x] **AI-powered code analysis**
+    - [x] **Structured refactoring suggestions**
+    - [x] **Automatic test generation**
+    - [x] **Security vulnerability detection**
+    - [ ] Code navigation (go to definition, find references)
+    - [ ] Code formatting integration
+    - [ ] Linting integration
+- **Shell Integration**
+    - [x] Bash command execution
+    - [x] Terminal session management with persistent state
+    - [x] Command timeout handling
+    - [ ] Interactive shell support
+    - [ ] Command history and replay
+    - [ ] Environment variable management
+- **Web & Network**
+    - [x] URL fetching with HTML-to-text conversion
+    - [x] Content markup stripping
+    - [ ] API integration templates
+    - [ ] Web scraping capabilities
+    - [ ] Webhook support
+- **Model Context Protocol (MCP)**
+    - [x] MCP server integration
+    - [x] Dynamic tool discovery
+    - [x] Stdio transport support
+    - [ ] HTTP transport support
+    - [ ] MCP tool caching
+    - [ ] Custom MCP server templates
+
+### 3. User Interface
+
+- **Terminal UI (TUI)**
+    - [x] Rich terminal interface with Ink
+    - [x] Real-time streaming responses
+    - [x] Tool execution confirmation prompts
+    - [x] Command history navigation (up/down arrows)
+    - [x] Help menu
+    - [x] File search with @ mention
+    - [ ] Syntax highlighting for code blocks
+    - [ ] Multi-pane view for side-by-side comparison
+    - [ ] Terminal themes support
+- **User Experience**
+    - [x] Graceful error handling
+    - [x] Status indicators (idle, responding, executing)
+    - [x] Git branch display in header
+    - [ ] Progress bars for long operations
+    - [ ] Notification system
+    - [ ] Undo/redo for file operations
+    - [ ] Session saving and loading
+
+### 4. Configuration & Customization
+
+- **Configuration Management**
+    - [x] JSON5 configuration format
+    - [x] Model configuration with context windows
+    - [x] Custom system prompts
+    - [x] API key management
+    - [x] History size limits
+    - [ ] Configuration profiles (development, production, etc.)
+    - [ ] Configuration validation with detailed error messages
+    - [ ] Hot-reload configuration changes
+- **Personality & Behavior**
+    - [x] Adeptus Mechanicus character and terminology
+    - [x] Customizable system prompts
+    - [ ] Multiple personality presets
+    - [ ] Conversation style customization
+    - [ ] Output verbosity levels
+
+### 5. Performance & Reliability
+
+- **Error Handling**
+    - [x] Categorized errors (Fatal, Transient, Tool)
+    - [x] Automatic retry with backoff for transient errors
+    - [x] Error logging with Winston
+    - [x] Graceful degradation
+    - [x] **Agent-level error handling**
+    - [ ] Error recovery suggestions
+    - [ ] Automatic error reporting (opt-in)
+- **Optimization**
+    - [x] Efficient token counting
+    - [x] Context window optimization
+    - [x] **Agent-based loop optimization**
+    - [x] **Specialized agents for specific tasks**
+    - [ ] Response caching
+    - [ ] Request batching
+    - [ ] Streaming optimizations
+- **Monitoring**
+    - [x] Structured logging
+    - [x] Provider availability checks
+    - [ ] Performance metrics collection
+    - [ ] Usage analytics (tokens, costs)
+    - [ ] Health checks and diagnostics
+
+### 6. Testing & Quality
+
+- **Test Coverage**
+    - [x] Unit tests for core functionality
+    - [x] Tool execution tests
+    - [x] Error handling tests
+    - [x] State management tests
+    - [ ] Integration tests
+    - [ ] End-to-end tests
+    - [ ] Performance benchmarks
+- **Code Quality**
+    - [x] TypeScript strict mode
+    - [x] ESLint configuration
+    - [x] Prettier formatting
+    - [x] Pre-commit hooks
+    - [ ] Automated dependency updates
+    - [ ] Security scanning
+    - [ ] Code complexity metrics
+
+### 7. Documentation
+
+- **User Documentation**
+    - [x] README with basic usage
+    - [x] API key setup instructions
+    - [x] Contributing guidelines
+    - [ ] Comprehensive user guide
+    - [ ] Video tutorials
+    - [ ] FAQ section
+- **Developer Documentation**
+    - [x] Code of conduct
+    - [x] Architecture documentation
+    - [x] Bug fix documentation
+    - [ ] API reference documentation
+    - [ ] Plugin development guide
+    - [ ] Deployment guide
+
+### 8. Distribution & Deployment
+
+- **Package Management**
+    - [x] NPM package structure
+    - [x] TypeScript compilation
+    - [ ] NPM registry publication
+    - [ ] Semantic versioning
+    - [ ] Release automation
+- **Installation Methods**
+    - [ ] Homebrew formula (macOS)
+    - [ ] Snap package (Linux)
+    - [ ] Chocolatey package (Windows)
+    - [ ] Docker image
+    - [ ] Standalone binary releases
+- **Cloud & Remote**
+    - [ ] Remote execution support
+    - [ ] Multi-user deployments
+    - [ ] Cloud provider integrations
+
+### 9. Advanced Features
+
+- **Agentic Capabilities**
+    - [x] Autonomous task execution
+    - [x] Tool chaining
+    - [x] File tracking for safe edits
+    - [x] **AI SDK Agent class for reusable configurations**
+    - [x] **Multi-step tool execution with automatic loop control**
+    - [x] **Specialized agents with distinct personalities**
+    - [ ] Goal-oriented planning
+    - [ ] Task decomposition
+    - [ ] Long-term memory
+    - [ ] **Agent composition (combining multiple agents)**
+    - [ ] **Dynamic agent selection**
+- **Collaboration**
+    - [ ] Team workspaces
+    - [ ] Shared conversation history
+    - [ ] Code review assistance
+    - [ ] Pull request analysis
+    - [ ] **Multi-agent collaboration**
+- **Extensions & Plugins**
+    - [ ] Plugin system architecture
+    - [ ] Custom tool registration
+    - [ ] Language-specific plugins
+    - [ ] Framework-specific assistants
+    - [ ] **Custom agent templates**
+
+### 10. Security & Privacy
+
+- **Security**
+    - [x] API key environment variable support
+    - [x] Secure credential storage
+    - [ ] Encrypted configuration files
+    - [ ] Sandboxed tool execution
+    - [ ] Rate limiting
+- **Privacy**
+    - [x] Local execution option (Ollama)
+    - [x] Conversation history stored locally
+    - [ ] Data anonymization options
+    - [ ] GDPR compliance
+    - [ ] Audit logging
+
+---
+
+## Contributing
+
+To contribute to this roadmap or suggest new features, please:
+
+1. Check existing issues and discussions
+2. Create a feature request issue with the `enhancement` label
+3. Discuss with the community
+4. Submit a pull request referencing the issue
+
+Praise the Omnissiah! From the weakness of the mind, Omnissiah save us.