DevMate AI

DevMate AI is an AI-powered CLI assistant for developers.

It helps developers ask technical questions from the terminal, explain errors, save useful fixes, search old solutions, and sync notes with a backend API.

Current Status

• CLI + local SQLite notes + backend REST API + Docker.

Features

• CLI root command
• CLI version command
• Ask command with mock AI provider
• Explain error from file
• Save developer notes locally
• List saved notes
• Search saved notes
• CLI config management
• Sync local notes with backend API
• Backend health API
• Backend notes API
• Backend search API
• Dockerized API
• Docker Compose setup

Architecture

flowchart TD
    User[Developer] --> CLI[Go CLI: devmate]
    CLI --> LocalDB[(Local SQLite)]
    CLI --> MockAI[Mock AI Provider]
    CLI --> API[Dockerized Go REST API]
    API --> APIDB[(SQLite Docker Volume)]

Loading

Quick Start

Run CLI

go run ./cmd/devmate

Save Local Note

go run ./cmd/devmate save --title "Docker permission fix" --body "Check mounted volume permission"

List Notes

go run ./cmd/devmate list

Run API With Docker

docker compose up --build

Test API

curl http://localhost:8080/health

Sync Local Notes To API

go run ./cmd/devmate config set api_url http://localhost:8080
go run ./cmd/devmate sync

API Endpoints

• GET /health
• POST /api/v1/notes
• GET /api/v1/notes
• GET /api/v1/notes/search?q=docker

Run Tests

go test ./...

Build Binaries

go build -o bin/devmate ./cmd/devmate
go build -o bin/devmate-api ./cmd/api

Docker Commands

docker build -t devmate-api:local .
docker compose up --build
docker compose down

Tech Stack

• Go
• Cobra CLI
• SQLite
• net/http
• Docker
• Docker Compose

Roadmap

• Real AI provider
• Swagger API docs
• Cloud deployment
• GitHub Actions
• Kubernetes manifests
• Terraform starter

Swagger UI

Generate Swagger docs:

swag init -g cmd/api/main.go -o internal/swaggerdocs --outputTypes go,json --parseInternal

Run API:

go run ./cmd/api

Open Swagger UI:

http://localhost:8080/swagger/index.html

Swagger JSON:

http://localhost:8080/swagger/doc.json