MAx Framework

Universal AI development assistant with GraphQL + REST microservices architecture

Package Status: npm | PyPI | License: MIT

Quick Start

# Install
npm install -g MAx
# OR
pip install MAx

# Initialize in project
max install

# Run commands
max test
max setup web-app
max quality

Architecture Overview

Client App (VS Code/Cursor/Claude)
       ↓ GraphQL queries
[GraphQL Proxy] :8080
       ↓ HTTP requests
[REST API] :8000
       ↓ Direct calls
MAx Package
       ↓ File system
.max/ (cache + config)

API Reference

GraphQL API

Endpoint: http://localhost:8080/graphql Client: src/graphql-client.ts Docs: API Reference

import { MaxGraphQLClient } from 'MAx';

const client = new MaxGraphQLClient();
await client.executeCommand('test', [], '/path/to/project');

REST API

Endpoint: http://localhost:8000 Docs: API Reference

import requests
response = requests.post('http://localhost:8000/api/execute',
                        json={'command': 'test', 'args': []})

Command Library

Core Commands

| Command | Description | Usage | |---------|-------------|-------| | install | Initialize MAx in project | max install | | test | Run test suite | max test [file] | | setup | Create project from template | max setup <template> | | quality | Run quality checks | max quality | | perf | Performance analysis | max perf |

Development Commands

| Command | Description | Usage | |---------|-------------|-------| | coding | Apply coding standards | max coding | | docs | Generate documentation | max docs | | config | Manage configuration | max config set <key> <value> | | persona | Set AI persona | max persona set <persona> |

Full Command Reference: CLI Commands Guide

Project Structure

MAx/
├── .max/                     # Core framework
│   ├── api/                 # GraphQL + REST servers
│   ├── core/                # Command execution engine
│   ├── workflows/           # Command definitions
│   ├── templates/           # Project templates
│   └── testing/             # Test files
├── src/                     # Node.js/TypeScript client
│   ├── graphql-client.ts    # GraphQL client
│   ├── cli.ts              # CLI interface
│   └── index.ts            # Entry point
├── docs/                    # Documentation
│   ├── guides/             # In-depth guides
│   └── *.md                # Main docs
├── tests/                   # Test suites
└── scripts/                 # Utility scripts

Documentation

� Getting Started

• Quick Start - 5-minute setup
• Installation - All installation options
• User Guide - Complete manual

🏗️ Development

• Developer Guide - Contributing & setup
• Architecture - System architecture
• API Reference - Complete API docs

🛠️ Configuration

• Configuration Guide - Project setup
• CLI Commands - All commands
• Project Templates - Available templates

🧪 Testing & Quality

• Testing Guide - Run & write tests
• Quality Gates - Code standards
• Performance - Optimization

� Deployment

• Deployment Guide - Production setup
• Docker Guide - Container deployment
• CI/CD Setup - GitHub Actions

📚 Reference

• Troubleshooting - Debug & fixes
• Contributing - How to contribute
• Changelog - Version history

Installation

Option 1: npm (Recommended)

npm install -g MAx
max install

Option 2: PyPI

pip install MAx
max install

Option 3: GitHub

npm install github:ethandellaposta/MAx
max install

Option 4: Docker

docker run --rm -v $(pwd):/app ethandellaposta/MAx:latest

Development Setup

# Clone repository
git clone https://github.com/ethandellaposta/MAx.git
cd MAx

# Install dependencies
npm install
pip install -r requirements-api.txt

# Start development servers
./scripts/start-api.sh

# Run tests
npm test
python -m pytest

Full Setup: Developer Guide

Configuration

Project Configuration

# Set theme
max config set theme dark

# Set AI persona
max persona set senior-developer

# View status
max status

Environment Variables

export MAX_API_PORT=8000
export MAX_GRAPHQL_PORT=8080
export MAX_LOG_LEVEL=info

Complete Configuration: Configuration Guide

Testing

Run Tests

# All tests
max test

# Specific file
max test path/to/test.py

# Quick tests
max test::quick

Test Categories

• Unit Tests: Component testing
• Integration Tests: API testing
• Performance Tests: Load testing
• Quality Tests: Code quality checks

Testing Guide: Testing Documentation

Status & Roadmap

✅ Current Release (v1.0.0)

• GraphQL + REST microservices
• 20+ AI-powered commands
• TypeScript/Node.js client
• Python REST API server
• Project templates
• Quality gates
• CI/CD pipelines
• Docker support

🔄 In Development

• VS Code extension
• Cursor plugin
• Claude Code MCP server
• Performance optimization
• Advanced caching

🎯 Planned

• JetBrains IDE plugin
• Web dashboard
• Multi-tenant support
• Enterprise features

Links & Resources

Packages & Distribution

• npm Package
• PyPI Package
• Docker Hub

Code & Issues

• GitHub Repository
• Issues & Support
• Discussions

Documentation

• Documentation Index
• API Reference
• Architecture Overview

License

MIT License - see LICENSE file for details.