Skip to content
lleitep3Public

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

374 Commits

Folders and files

Repository files navigation

AICockpit - AI Harness Engineering Platform

Test and Lint Build Go Version License

O AICockpit Γ© o sistema operacional local definitivo para IAs autΓ΄nomas. Ele amplifica as capacidades do seu Agente de IA favorito (como Antigravity, Devin ou Claude), fornecendo um Cofre Seguro (Vault) nativo, um Dashboard Visual para humanos colaborarem com a IA, e um Gerenciador de Habilidades (Packages) integrado.


πŸš€ 1. InstalaΓ§Γ£o e Setup Inicial

Comece instalando a CLI localmente (requer Go 1.26+):

# 1. Instale o AICockpit via Go
go install github.com/lleitep3/aicockpit@latest

# 2. Rode o setup interativo (Selecione sua IA preferida, ex: Antigravity)
cockpit setup

πŸ“¦ 2. Adicione o Registry Oficial

O ecossistema do Cockpit Γ© extensΓ­vel. Conecte-se ao registry oficial para ter acesso Γ s melhores ferramentas e habilidades:

cockpit pkg registry add default https://github.com/lleitep3/cockpit-registry

πŸ› οΈ 3. Instale os MΓ³dulos Essenciais

Para uma experiΓͺncia completa (incluindo interface visual e gestΓ£o de tarefas Kanban), instale os pacotes e utilize os recursos nativos:

# Instale a interface visual interativa (UI)
cockpit pkg install cockpit-dashboard

(Nota: O gerenciador Kanban cockpit project jΓ‘ Γ© nativo no core da CLI!)

πŸ€– 4. Trabalhe Junto com a IA

Agora sua infraestrutura estΓ‘ pronta! Abra o terminal, inicie sua IA (como Antigravity ou Devin) e trabalhe de forma integrada:

VocΓͺ: "IA, use o cockpit project para criar uma nova tarefa para refatorar o login. Depois abra o dashboard visual."

A IA irΓ‘ utilizar automaticamente as habilidades locais que vocΓͺ instalou e interagir com o Cofre Seguro do seu sistema operacional, sem precisar expor chaves de API em texto plano!


πŸ“š DocumentaΓ§Γ£o e Arquitetura

Getting Started

Features & Usage

Development

Project Information

πŸ’» Developer Installation (From Source)

Prerequisites

  • Go 1.26 or later
  • Linux, macOS, or Windows
  • Git

Linux/macOS

Option 1: User-Level Installation (Recommended)

# Clone the repository
git clone git@github.com:lleitep3/aicockpit.git
cd aicockpit

# Build and install (automatic PATH configuration)
make install

# Verify installation
cockpit --version

Option 2: System-Wide Installation (Global)

# Build and install globally (requires sudo)
make install-global

# Verify installation
cockpit --version

Windows

# Build and install
make install-win

# Verify installation
cockpit --version

Initial Setup

# Run setup wizard
cockpit setup

# Check system health
cockpit doctor

# View configuration
cockpit info

For more details, see Quick Start Guide.

πŸ“‹ ReferΓͺncia de Comandos

Core Commands

  • cockpit setup - Interactive setup wizard

    • Select language (English, Portuguese)
    • Choose AI provider (Claude, GPT, Devin, Antigravity, Goose)
    • Initialize vault and configuration
  • cockpit info - Display AICockpit information

    • Show current configuration
    • List installed packages
    • Display file locations
  • cockpit doctor - Health check

    • Verify all components are properly configured
    • Check directory structure
    • Validate configuration files
  • cockpit uninstall - Remove AICockpit

    • Safely uninstall and remove all data

Metrics & Analytics

  • cockpit metrics list - View execution metrics

    • Filter by command, status, or date
    • Limit results
    • View all command executions
  • cockpit metrics stats - Show execution statistics

    • Total executions and success rate
    • Average duration
    • Command frequency
    • Error types
  • cockpit metrics logs - View log files

    • List all log files
    • View logs for specific date
    • Check log file details

Security & Secrets

  • cockpit vault set - Store a secret securely in the OS Keyring
  • cockpit vault get - Retrieve a secret
  • cockpit vault remove - Remove a secret

Packages & Extensibility

  • cockpit pkg install - Install a new package (e.g. cockpit-dashboard)
  • cockpit pkg search - Search for available packages in registries
  • cockpit pkg upgrade - Upgrade installed packages
  • cockpit pkg registry - Manage multiple package registries

Project & Task Management

  • cockpit project sync - Sync local tasks bi-directionally with GitHub Issues
  • cockpit project add - Create a new task in the Kanban board
  • cockpit project move - Change the state of a task (todo, in_progress, done)

Assistant

  • cockpit ask "<task>" - Run one assistant turn (memory recall, a claude, codex, or API worker, streamed output, and retain). See cockpit ask.

Planned Commands

  • cockpit agent - Not a command. Run a task with cockpit ask (product vision)
  • cockpit skills - Manage skills explicitly
  • cockpit rules - Manage rules explicitly

🌍 Internationalization

AICockpit supports multiple languages:

  • English (en-us)
  • Portuguese Brazilian (pt-br)

Set language globally:

cockpit --language pt-br info

πŸ“ Directory Structure

AICockpit creates the following structure in ~/.cockpit/:

~/.cockpit/
β”œβ”€β”€ config.yaml          # Configuration file
β”œβ”€β”€ metrics.json         # Execution metrics
β”œβ”€β”€ logs/                # Log files (daily rotation)
β”‚   β”œβ”€β”€ cockpit-2026-06-20.log
β”‚   β”œβ”€β”€ cockpit-2026-06-21.log
β”‚   └── ...
β”œβ”€β”€ cache/               # Cache directory
β”œβ”€β”€ packages/            # Installed packages
β”œβ”€β”€ vault/               # Secrets vault
β”œβ”€β”€ agents/              # AI agents
β”œβ”€β”€ skills/              # Skills
β”œβ”€β”€ rules/               # Rules
β”œβ”€β”€ hooks/               # Hooks
└── kb/                  # Knowledge bases

πŸ”§ Development

Build Commands

make help              # Show all available commands
make build             # Build the binary
make test              # Run tests with coverage
make lint              # Run linters
make fmt               # Format code
make check             # Run all checks
make clean             # Clean build artifacts
make install-hooks     # Install git pre-commit hooks

πŸ§‘β€πŸ’» Identity File

AICockpit supports a local identity.md file to store your personal developer profile, workspace preferences and AI communication conventions.

  • Use internal/assets/default_cockpit/identity-example.md as a starting point.
  • Copy it to identity.md and update your own name, role, location, stack and workflow preferences.
  • identity.md is ignored by Git to keep personal identity data local.

Project Structure

aicockpit/
β”œβ”€β”€ cmd/                    # CLI commands
β”‚   β”œβ”€β”€ setup.go
β”‚   β”œβ”€β”€ info.go
β”‚   β”œβ”€β”€ doctor.go
β”‚   β”œβ”€β”€ uninstall.go
β”‚   β”œβ”€β”€ metrics.go
β”‚   └── root.go
β”œβ”€β”€ internal/               # Internal packages
β”‚   β”œβ”€β”€ config/            # Configuration management
β”‚   β”œβ”€β”€ logger/            # Logging system (deprecated)
β”‚   β”œβ”€β”€ i18n/              # Internationalization
β”‚   └── logging/           # New logging & metrics system
β”œβ”€β”€ scripts/                # Installation scripts
β”‚   β”œβ”€β”€ install.sh         # Linux/macOS installer
β”‚   └── install.ps1        # Windows installer
β”œβ”€β”€ .github/                # GitHub configuration
β”‚   β”œβ”€β”€ workflows/         # GitHub Actions
β”‚   └── PULL_REQUEST_TEMPLATE.md
β”œβ”€β”€ docs/                   # Documentation
β”œβ”€β”€ main.go                 # Entry point
β”œβ”€β”€ Makefile                # Build automation
β”œβ”€β”€ CONTRIBUTING.md         # Contribution guidelines
└── README.md               # This file

Testing

# Run all tests
make test

# Run specific package tests
go test -v ./internal/config

# View coverage report
go tool cover -html=coverage.out

πŸ“Š Code Quality

  • Linting: go vet and golangci-lint
  • Testing: Unit tests with β‰₯90% coverage target (current: 68.0% β€” work in progress)
  • Formatting: go fmt compliance
  • Documentation: Comprehensive guides and examples
  • CI/CD: GitHub Actions for automated validation

πŸ” Security

  • Secrets are stored in OS keyrings (planned)
  • All operations are logged
  • Configuration is user-specific
  • No sensitive data in logs
  • Pre-commit hooks validate code quality

πŸ“Š Logging & Metrics

AICockpit automatically tracks all command executions with detailed metrics:

# View execution metrics
cockpit metrics list

# View statistics
cockpit metrics stats

# View log files
cockpit metrics logs

# Filter by command
cockpit metrics list --command setup

# Filter by status
cockpit metrics list --status error

# Filter by date
cockpit metrics list --date 2026-06-20

Features:

  • Daily log rotation (cockpit-YYYY-MM-DD.log)
  • JSON format for easy parsing
  • Automatic metrics collection
  • Success/failure tracking
  • Performance metrics
  • Error analysis

See Logging & Metrics Documentation for details.

🀝 Contributing

We welcome contributions! Please follow these guidelines:

  1. Read the Contributing Guide - Important guidelines and standards
  2. Semantic Commits - Use conventional commit format
  3. PR Requirements - Include [MAJOR], [MINOR], or [PATCH] in PR title
  4. Tests - Write tests for new features
  5. Quality - Run make check before committing

Quick Contribution Steps

# 1. Fork and clone
git clone git@github.com:YOUR_USERNAME/aicockpit.git
cd aicockpit

# 2. Create feature branch
git checkout -b feature/your-feature

# 3. Install pre-commit hooks
make install-hooks

# 4. Make changes and commit
git add .
git commit -m "feat(scope): description"

# 5. Run checks
make check

# 6. Push and create PR
git push origin feature/your-feature

πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

πŸ™‹ Support

For issues, questions, or suggestions:

  1. Check existing issues
  2. Create a new issue
  3. Join discussions

πŸ—ΊοΈ Roadmap

Phase 1 βœ… (Complete)

  • βœ… Core CLI structure
  • βœ… Configuration system
  • βœ… Logging, Metrics, and i18n
  • βœ… Installation scripts (user-level & system-wide)

Phase 2 βœ… (Complete)

  • βœ… Vault system (keyring integration)
  • βœ… Package management (cockpit pkg and registries)
  • βœ… Project management (Kanban & GitHub Sync)
  • βœ… Visual Dashboard (SvelteKit/FastAPI)
  • βœ… Knowledge base search (BM25 + Graph Traversal)

Phase 3 (In Progress)

  • Agent management system
  • Skills and rules framework
  • Hooks system
  • Advanced metrics & token analytics

Phase 4 (Vision)

  • AI-powered autonomous optimization
  • Performance and cost analysis trends

πŸ“ˆ Project Statistics

  • Total Commits: 120+
  • Lines of Code: 28000+
  • Lines of Documentation: 18000+
  • Test Coverage: 68.0%
  • Tests Passing: 737/737 in 12 packages βœ“

πŸŽ“ Learn More

For Users

For Developers

For Project Managers

πŸ™Œ Acknowledgments

AICockpit is built with:

πŸ“ž Contact


Made with ❀️ for AI systems everywhere

Knowledge Base (KB)

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages