@vfarcic/dot-ai 0.117.0 β†’ 0.118.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +91 -140
  2. package/package.json +1 -1
  3. package/shared-prompts/prd-create.md +15 -1
  4. package/shared-prompts/prd-done.md +1 -0
  5. package/shared-prompts/prd-next.md +0 -2
  6. package/shared-prompts/prd-start.md +2 -2
package/README.md CHANGED
@@ -4,146 +4,81 @@
4
4
 
5
5
  ![DevOps AI Toolkit Logo](assets/images/logo.png)
6
6
 
7
+ [![npm version](https://badge.fury.io/js/%40vfarcic%2Fdot-ai.svg)](https://www.npmjs.com/package/@vfarcic/dot-ai)
8
+ [![npm downloads](https://img.shields.io/npm/dm/@vfarcic/dot-ai.svg)](https://www.npmjs.com/package/@vfarcic/dot-ai)
9
+ [![GitHub release](https://img.shields.io/github/release/vfarcic/dot-ai.svg)](https://github.com/vfarcic/dot-ai/releases/latest)
10
+ [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
11
+ ![Project Status](https://img.shields.io/badge/status-beta-orange)
12
+ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/vfarcic/dot-ai/badge)](https://scorecard.dev/viewer/?uri=github.com/vfarcic/dot-ai)
13
+ [![GitHub stars](https://img.shields.io/github/stars/vfarcic/dot-ai.svg?style=social&label=Star)](https://github.com/vfarcic/dot-ai)
14
+
7
15
  </div>
8
16
 
9
- DevOps AI Toolkit is an AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance.
17
+ **AI-powered platform engineering and DevOps automation through intelligent Kubernetes operations and conversational workflows.**
10
18
 
11
19
  πŸ“š [Quick Start](./docs/quick-start.md) | πŸ”§ [MCP Setup](./docs/mcp-setup.md) | πŸ› οΈ [Features & Tools](./docs/mcp-tools-overview.md)
12
20
 
13
- ## Who is this for?
14
-
15
- ### Kubernetes Deployment
16
- - **Developers**: Deploy applications without needing deep Kubernetes expertise
17
- - **Platform Engineers**: Create organizational deployment patterns that enhance AI recommendations with institutional knowledge and best practices, and scan cluster resources to enable semantic matching for dramatically improved recommendation accuracy
18
- - **Security Engineers**: Define governance policies that integrate into deployment workflows with optional Kyverno enforcement
19
-
20
- ### Kubernetes Issue Remediation
21
- - **DevOps Engineers**: Quickly diagnose and fix Kubernetes issues without deep troubleshooting expertise
22
- - **SRE Teams**: Automate root cause analysis and generate executable remediation commands
23
- - **Support Teams**: Handle incident response with AI-guided investigation and repair workflows
24
-
25
- <!--
26
- ### Platform Building
27
- DEVELOPER NOTE: This tool is under active development with incomplete functionality. Not recommended for production use.
28
- - **Platform Engineers**: Install and configure platform tools conversationally without memorizing script paths and commands
29
- - **New Team Members**: Build platform infrastructure through zero-knowledge guided workflows
30
- - **DevOps Teams**: Create and manage Kubernetes clusters through natural language interactions
31
- -->
32
-
33
- ### Shared Prompts Library
34
- - **Development Teams**: Share proven prompts across projects without file management
35
- - **Project Managers**: Standardize workflows with consistent prompt usage across teams
36
- - **Individual Developers**: Access curated prompt library via native slash commands
37
-
38
- ### Project Setup & Governance
39
- - **Project Maintainers**: Bootstrap new repositories with governance, legal, and security files
40
- - **Development Teams**: Standardize repository setup and workflows across projects
41
- - **Security Teams**: Implement consistent security policies, vulnerability reporting, and compliance standards
42
-
43
- ### AI Integration
44
- - **AI Agents**: Integrate all capabilities with Claude Code, Cursor, or VS Code for conversational workflows
45
- - **Multiple AI Providers**: Choose from multiple AI models and providers to optimize for quality, cost, and reliability - see [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
46
- - **REST API**: Access all tools via standard HTTP endpoints for CI/CD pipelines, automation scripts, and traditional applications
21
+ ---
47
22
 
48
- ## Key Features
23
+ ## What is DevOps AI Toolkit?
49
24
 
50
- ### Kubernetes Deployment Intelligence
51
- πŸ” **Smart Discovery**: Automatically finds all available resources and operators in your cluster
52
- 🧠 **Semantic Capability Management**: Discovers what each resource actually does for intelligent matching
53
- πŸ€– **AI Recommendations**: Smart intent clarification gathers missing context, then provides deployment suggestions tailored to your specific cluster setup with enhanced semantic understanding
54
- πŸ”§ **Operator-Aware**: Leverages custom operators and CRDs when available
55
- πŸš€ **Complete Workflow**: From discovery to deployment with automated Kubernetes integration
25
+ DevOps AI Toolkit brings AI-powered intelligence to platform engineering, Kubernetes operations, and development workflows. It provides intelligent Kubernetes deployment recommendations through capability discovery and semantic matching, AI-powered issue remediation, automated repository setup with governance and security files, and shared prompt libraries for consistent development workflowsβ€”all through natural language conversation.
56
26
 
57
- πŸ“– [Learn more β†’](./docs/mcp-recommendation-guide.md)
27
+ Built on the Model Context Protocol (MCP), it integrates seamlessly with Claude Code, Cursor, and VS Code to provide conversational interaction for complex DevOps and development tasks.
58
28
 
59
- #### Capability-Enhanced Recommendations
60
- Transform how AI understands your cluster by discovering semantic capabilities of each resource:
29
+ ## Mission
61
30
 
62
- **The Problem**: Traditional discovery sees `sqls.devopstoolkit.live` as a meaningless name among hundreds of resources.
31
+ DevOps AI Toolkit democratizes platform engineering and cloud native operations by making complex workflows accessible through AI-powered automation. We eliminate the expertise barrier that prevents teams from adopting best practices in Kubernetes operations, repository governance, and standardized development workflowsβ€”making professional-grade DevOps accessible through natural language interaction.
63
32
 
64
- **The Solution**: Capability management teaches the system that `sqls.devopstoolkit.live` handles PostgreSQL databases with multi-cloud support.
33
+ ## Who Should Use This?
65
34
 
66
- **Before Capability Management:**
67
- ```
68
- User: "I need a PostgreSQL database"
69
- AI: Gets 400+ generic resource names β†’ picks complex multi-resource solution
70
- Result: Misses optimal single-resource solutions
71
- ```
35
+ **DevOps AI Toolkit is for teams who want to**:
36
+ - Manage cloud resources (AWS, Azure, GCP) using Kubernetes as a control plane (developers, platform engineers)
37
+ - Quickly diagnose and fix cluster and infrastructure issues (SREs, DevOps engineers)
38
+ - Standardize resource provisioning with organizational patterns and policies (security engineers, platform teams)
39
+ - Bootstrap repositories with governance and security files (project maintainers)
40
+ - Access curated development prompts through native slash commands (development teams)
72
41
 
73
- **After Capability Management:**
74
- ```
75
- User: "I need a PostgreSQL database"
76
- AI: Gets pre-filtered relevant resources with rich context
77
- Result: Finds sqls.devopstoolkit.live as perfect match ✨
78
- ```
42
+ ## Scope
79
43
 
80
- πŸ“– [Learn more β†’](./docs/mcp-capability-management-guide.md)
44
+ ### In Scope
45
+ - AI-powered resource provisioning recommendations using Kubernetes as control plane
46
+ - Intelligent issue remediation and root cause analysis
47
+ - Organizational pattern and policy management with semantic search
48
+ - MCP-based integration with AI coding assistants
49
+ - Multi-provider AI model support (Claude, GPT, Gemini)
50
+ - Project setup with governance, legal, and security files
81
51
 
82
- ### Kubernetes Issue Remediation
83
- πŸ” **AI-Powered Root Cause Analysis**: Multi-step investigation loop identifies the real cause behind Kubernetes failures
84
- πŸ› οΈ **Executable Remediation**: Generates specific kubectl commands with risk assessment and validation
85
- ⚑ **Dual Execution Modes**: Manual approval workflow or automatic execution based on confidence thresholds
86
- πŸ”’ **Safety Mechanisms**: Automatic fallback to manual mode when validation discovers additional issues
87
- 🎯 **Cross-Resource Intelligence**: Understands how pod issues may require fixes in different resource types (storage, networking, etc.)
52
+ ### Out of Scope
53
+ - Kubernetes cluster provisioning/management (delegates to existing tools)
54
+ - CI/CD pipeline execution (provides recommendations only)
55
+ - Application runtime monitoring (integrates with existing observability tools)
88
56
 
89
- πŸ“– [Learn more β†’](./docs/mcp-remediate-guide.md)
57
+ ## Key Features
90
58
 
91
- <!--
92
- ### Platform Building
93
- DEVELOPER NOTE: This tool is under active development with incomplete functionality. Not recommended for production use.
94
- πŸ—£οΈ **Natural Language Operations**: Install tools and create clusters through conversation without memorizing commands
95
- πŸ” **Dynamic Discovery**: Automatically discovers 21+ available platform operations from infrastructure scripts
96
- πŸ€– **AI-Powered Intent Mapping**: Understands variations like "Install Argo CD", "Set up ArgoCD", "Deploy Argo CD"
97
- πŸ’¬ **Conversational Configuration**: Guides through parameter collection step-by-step with sensible defaults
98
- 🎯 **Zero-Knowledge Onboarding**: New users successfully build platforms without documentation
99
-
100
- πŸ“– [Learn more β†’](./docs/mcp-build-platform-guide.md)
101
- -->
102
-
103
- ### Organizational Pattern Management
104
- πŸ›οΈ **Pattern Creation**: Define organizational deployment patterns that capture institutional knowledge
105
- 🧠 **AI Enhancement**: Patterns automatically enhance deployment recommendations with organizational context
106
- πŸ” **Semantic Search**: Uses Vector DB (Qdrant) for intelligent pattern matching based on user intent
107
- πŸ“‹ **Best Practices**: Share deployment standards across teams through reusable patterns
108
-
109
- πŸ“– [Learn more β†’](./docs/pattern-management-guide.md)
110
-
111
- ### Policy Management & Governance
112
- πŸ›‘οΈ **Policy Creation**: Define governance policies that guide users toward compliant configurations
113
- ⚠️ **Compliance Integration**: Policies create required questions with compliance indicators during deployment
114
- πŸ€– **Kyverno Generation**: Automatically generates Kyverno ClusterPolicies for active enforcement
115
- 🎯 **Proactive Governance**: Prevents configuration drift by embedding compliance into the recommendation workflow
116
- πŸ” **Vector Storage**: Uses Qdrant Vector DB for semantic policy matching and retrieval
117
-
118
- πŸ“– [Learn more β†’](./docs/policy-management-guide.md)
119
-
120
- ### Shared Prompts Library
121
- 🎯 **Native Slash Commands**: Prompts appear as `/dot-ai:prompt-name` in your coding agent
122
- πŸ“š **Curated Library**: Access proven prompts for code review, documentation, architecture, and project management
123
- πŸ”„ **Zero Setup**: Connect to MCP server and prompts are immediately available across all projects
124
- 🀝 **Team Consistency**: Standardized prompt usage with centralized management
59
+ ### πŸ” Resource Provisioning Intelligence
60
+ Automatically discovers cluster resources using semantic capability management. AI understands what each resource actually does, providing intelligent recommendations for provisioning resources across clouds using Kubernetes as a control plane.
61
+ πŸ“– [Deployment Guide](./docs/mcp-recommendation-guide.md) | [Capability Management](./docs/mcp-capability-management-guide.md)
125
62
 
126
- πŸ“– [Learn more β†’](./docs/mcp-prompts-guide.md)
63
+ ### πŸ› οΈ Issue Remediation
64
+ AI-powered root cause analysis with multi-step investigation, executable remediation commands, and safety mechanisms for manual or automatic execution.
65
+ πŸ“– [Learn more β†’](./docs/mcp-remediate-guide.md)
127
66
 
128
- ### Project Setup & Governance
129
- πŸ“¦ **Repository Audit**: Scans repositories to identify missing governance, legal, and automation files
130
- πŸ“‹ **25+ Templates**: Generates LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, GitHub workflows, and automation
131
- πŸ”§ **GitHub Automation**: Sets up Renovate for dependency updates, PR labeling, and stale issue management
132
- πŸ›‘οΈ **Security Workflows**: Includes OpenSSF Scorecard for security posture analysis
133
- βœ… **Standards-Based**: All templates based on authoritative sources (Contributor Covenant, OpenSSF, GitHub)
67
+ ### πŸ›οΈ Pattern & Policy Management
68
+ Capture organizational knowledge and governance policies that automatically enhance AI recommendations with best practices and compliance requirements. Uses vector search for intelligent semantic matching.
69
+ πŸ“– [Pattern Management](./docs/pattern-management-guide.md) | [Policy Management](./docs/policy-management-guide.md)
134
70
 
71
+ ### πŸ“¦ Project Setup & Governance
72
+ Generate 25+ governance, legal, and automation files (LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, GitHub workflows, Renovate, OpenSSF Scorecard) for repository standardization.
135
73
  πŸ“– [Learn more β†’](./docs/mcp-project-setup-guide.md)
136
74
 
137
- ### AI Integration
138
- ⚑ **MCP Integration**: Works seamlessly with Claude Code, Cursor, or VS Code through Model Context Protocol
139
- πŸ€– **Conversational Interface**: Natural language interaction for deployment, remediation, pattern management, and shared prompt workflows
140
- 🎯 **Multiple AI Providers**: Choose from multiple AI models and providers to optimize for quality, cost, and reliability - see [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
75
+ ### πŸ’¬ Shared Prompts Library
76
+ Access curated prompts as native slash commands (`/dot-ai:prompt-name`) in your coding agent for consistent workflows across projects.
77
+ πŸ“– [Learn more β†’](./docs/mcp-prompts-guide.md)
141
78
 
142
- **Setup Required**: See the [MCP Setup Guide](./docs/mcp-setup.md) for complete configuration instructions.
143
-
144
- ---
145
- πŸš€ **Ready to deploy?** Jump to the [Quick Start](./docs/quick-start.md) guide to begin using DevOps AI Toolkit.
146
- ---
79
+ ### ⚑ AI Integration
80
+ Works with Claude Code, Cursor, VS Code via Model Context Protocol. Supports multiple AI providers (Claude, GPT, Gemini) for flexibility and cost optimization.
81
+ πŸ“– [AI Model Configuration](./docs/mcp-setup.md#ai-model-configuration)
147
82
 
148
83
  ## See It In Action
149
84
 
@@ -151,42 +86,58 @@ DEVELOPER NOTE: This tool is under active development with incomplete functional
151
86
 
152
87
  This video explains the platform engineering problem and demonstrates the Kubernetes deployment recommendation workflow from intent to running applications.
153
88
 
154
- ## Documentation
155
-
156
- ### πŸš€ Getting Started
157
- - **[MCP Setup Guide](docs/mcp-setup.md)** - Complete configuration instructions for AI tools integration
158
- - **[Tools and Features Overview](docs/mcp-tools-overview.md)** - Comprehensive guide to all available tools and features
89
+ ## Quick Start
159
90
 
160
- ## Troubleshooting
91
+ Get started in 3 steps:
92
+ 1. Configure MCP server (Docker or npm)
93
+ 2. Connect your AI coding assistant (Claude Code, Cursor, VS Code)
94
+ 3. Start using conversational workflows
161
95
 
162
- ### MCP Issues
96
+ ## Documentation
163
97
 
164
- **MCP server won't start:**
165
- - Verify environment variables are correctly configured in `.mcp.json` env section
166
- - Check session directory exists and is writable
167
- - Ensure `ANTHROPIC_API_KEY` is valid
98
+ ### Getting Started
99
+ - **[Quick Start Guide](docs/quick-start.md)** - Get started in minutes
100
+ - **[MCP Setup Guide](docs/mcp-setup.md)** - Complete configuration instructions
101
+ - **[Tools Overview](docs/mcp-tools-overview.md)** - All available tools and features
168
102
 
169
- **"No active cluster" errors:**
170
- - Verify kubectl connectivity: `kubectl cluster-info`
171
- - Check KUBECONFIG path in environment variables
172
- - Test cluster access: `kubectl get nodes`
103
+ ### Feature Guides
104
+ - **[Resource Provisioning](docs/mcp-recommendation-guide.md)** - AI-powered deployment recommendations
105
+ - **[Capability Management](docs/mcp-capability-management-guide.md)** - Semantic resource discovery
106
+ - **[Issue Remediation](docs/mcp-remediate-guide.md)** - AI-powered troubleshooting
107
+ - **[Pattern Management](docs/pattern-management-guide.md)** - Organizational deployment patterns
108
+ - **[Policy Management](docs/policy-management-guide.md)** - Governance and compliance
109
+ - **[Project Setup](docs/mcp-project-setup-guide.md)** - Repository governance automation
173
110
 
174
111
  ## Support
175
112
 
176
- - **Issues**: [GitHub Issues](https://github.com/vfarcic/dot-ai/issues)
113
+ - **[Support Guide](SUPPORT.md)** - How to get help and where to ask questions
114
+ - **GitHub Issues**: [Bug reports and feature requests](https://github.com/vfarcic/dot-ai/issues)
115
+ - **GitHub Discussions**: [Community Q&A and discussions](https://github.com/vfarcic/dot-ai/discussions)
116
+ - **Troubleshooting**: See [Troubleshooting Guide](./docs/mcp-setup.md#troubleshooting) for common problems
117
+
118
+ ## Contributing & Governance
177
119
 
178
- ## Contributing
120
+ We welcome contributions from the community! Please review:
179
121
 
180
- We welcome contributions! Please:
181
- - Fork the repository and create a feature branch
182
- - Run integration tests to ensure changes work correctly (see [Integration Testing Guide](docs/integration-testing-guide.md))
183
- - Follow existing code style and conventions
184
- - Submit a pull request with a clear description of changes
122
+ - **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute code, docs, and ideas
123
+ - **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations
124
+ - **[Security Policy](SECURITY.md)** - How to report security vulnerabilities
125
+ - **[Governance](docs/GOVERNANCE.md)** - Project governance and decision-making
126
+ - **[Maintainers](docs/MAINTAINERS.md)** - Current project maintainers
127
+ - **[Roadmap](docs/ROADMAP.md)** - Project direction and priorities
185
128
 
186
129
  ## License
187
130
 
188
131
  MIT License - see [LICENSE](LICENSE) file for details.
189
132
 
133
+ ## Acknowledgments
134
+
135
+ DevOps AI Toolkit is built on:
136
+ - [Model Context Protocol](https://modelcontextprotocol.io/) for AI integration framework
137
+ - [Vercel AI SDK](https://sdk.vercel.ai/) for unified AI provider interface
138
+ - [Kubernetes](https://kubernetes.io/) for the cloud native foundation
139
+ - [CNCF](https://www.cncf.io/) for the cloud native ecosystem
140
+
190
141
  ---
191
142
 
192
- **DevOps AI Toolkit** - AI-powered development productivity platform for enhanced software development workflows.
143
+ **DevOps AI Toolkit** - Making cloud native operations accessible through AI-powered intelligence.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vfarcic/dot-ai",
3
- "version": "0.117.0",
3
+ "version": "0.118.0",
4
4
  "description": "AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance",
5
5
  "mcpName": "io.github.vfarcic/dot-ai",
6
6
  "main": "dist/index.js",
package/shared-prompts/prd-create.md CHANGED
@@ -118,6 +118,17 @@ Work through the PRD template focusing on project management, milestone tracking
118
118
 
119
119
  **CRITICAL**: Steps 2-4 must happen in this exact order to avoid the chicken-and-egg problem of needing the issue ID for the filename.
120
120
 
121
+ ### Step 5: Update ROADMAP.md (If It Exists)
122
+
123
+ After creating the PRD, check if `docs/ROADMAP.md` exists. If it does, add the new feature to the appropriate timeframe section based on PRD priority:
124
+ - **High Priority** β†’ Short-term section
125
+ - **Medium Priority** β†’ Medium-term section
126
+ - **Low Priority** β†’ Long-term section
127
+
128
+ Format: `- [Brief feature description] (PRD #[issue-id])`
129
+
130
+ The ROADMAP.md update will be included in the commit at the end of the workflow (Option 2).
131
+
121
132
  ## Next Steps After PRD Creation
122
133
 
123
134
  After completing the PRD, present the user with numbered options:
@@ -150,8 +161,10 @@ This will help identify the first task and set up the development workflow.
150
161
  If user chooses option 2:
151
162
 
152
163
  ```bash
153
- # Stage the PRD file
164
+ # Stage the PRD file (and ROADMAP.md if it was updated)
154
165
  git add prds/[issue-id]-[feature-name].md
166
+ # If docs/ROADMAP.md exists and was updated, include it:
167
+ # git add docs/ROADMAP.md
155
168
 
156
169
  # Commit with skip CI flag to avoid unnecessary CI runs
157
170
  git commit -m "docs(prd-[issue-id]): create PRD #[issue-id] - [feature-name] [skip ci]
@@ -159,6 +172,7 @@ git commit -m "docs(prd-[issue-id]): create PRD #[issue-id] - [feature-name] [sk
159
172
  - Created PRD for [brief feature description]
160
173
  - Defined [X] major milestones
161
174
  - Documented problem, solution, and success criteria
175
+ - Added to ROADMAP.md ([timeframe] section)
162
176
  - Ready for implementation"
163
177
 
164
178
  # Push to main
package/shared-prompts/prd-done.md CHANGED
@@ -33,6 +33,7 @@ Complete the PRD implementation workflow including branch management, pull reque
33
33
  - [ ] **No outstanding blockers**: All dependencies resolved and technical debt addressed
34
34
  - [ ] **Update PRD status**: Mark PRD as "Complete" with completion date
35
35
  - [ ] **Archive PRD file**: Move completed PRD to `./prds/done/` directory to maintain project organization
36
+ - [ ] **Update ROADMAP.md (if it exists)**: Remove the completed feature from `docs/ROADMAP.md` roadmap if the file exists
36
37
 
37
38
  **Note**: Tests will run automatically in the CI/CD pipeline when the PR is created. Do not run tests locally during the completion workflow.
38
39
 
package/shared-prompts/prd-next.md CHANGED
@@ -198,8 +198,6 @@ Present findings in this focused format:
198
198
 
199
199
  **Dependencies**: [What's already complete that makes this ready to work on]
200
200
 
201
- **Effort estimate**: [Realistic time estimate]
202
-
203
201
  **Success criteria**: [How you'll know it's done]
204
202
 
205
203
  ---
package/shared-prompts/prd-start.md CHANGED
@@ -10,6 +10,8 @@ category: project-management
10
10
 
11
11
  You are helping initiate active implementation work on a specific Product Requirements Document (PRD). This command bridges the gap between PRD planning and actual development work by setting up the implementation context and providing clear next steps.
12
12
 
13
+ **IMPORTANT**: Do NOT include time estimates or effort estimates in your responses. Focus on task prioritization, dependencies, and clear next steps without speculating on duration.
14
+
13
15
  ## Process Overview
14
16
 
15
17
  1. **Select Target PRD** - Ask user which PRD they want to implement
@@ -190,8 +192,6 @@ Present the implementation plan:
190
192
 
191
193
  **Success criteria**: [How you'll know this task is complete]
192
194
 
193
- **Estimated effort**: [Time estimate]
194
-
195
195
  **Next steps after this**: [What becomes possible once this is done]
196
196
 
197
197
  ## Implementation Approach