@yuvakiran-zen/zen-cli/README.MD

Intelligent Code Agent powered by Zen

# Zen CLI

![Node.js](https://img.shields.io/badge/Node.js-18%2B-brightgreen?style=flat-square) [![npm](https://img.shields.io/npm/v/@yuvakiran-zen/zen-cli.svg?style=flat-square)](https://www.npmjs.com/package/@yuvakiran-zen/zen-cli)

An intelligent AI development assistant that lives in your terminal. Zen CLI understands your codebase and accelerates development through natural language commands powered by advanced AI models.

📖 **[Documentation](https://cli.tryzen.ai)** | 🚀 **[Quick Start](#quick-start)** | 🔧 **[Configuration](#configuration)**

## Quick Start

```bash
# Install globally
npm install -g @yuvakiran-zen/zen-cli

# Set your API key
export ANTHROPIC_API_KEY="your-api-key-here"

# Start coding with AI assistance
zen-cli
```

## What makes Zen CLI different

- **🎨 Beautiful Terminal Interface**: Professionally designed UI with syntax highlighting, interactive menus, and smart paste detection
- **⚡ Streaming Responses**: Real-time AI responses with intelligent loading indicators
- **🔌 MCP Protocol Integration**: Built-in Model Context Protocol support for extensible functionality
- **🌐 Web Search Enabled**: Access to real-time documentation and community solutions
- **🛠️ Multi-Language Support**: JavaScript, TypeScript, Python, React, Vue, Angular, and more

## Core Features

### Intelligent Code Generation
- Generate complete applications, components, and modules
- Smart code completion and refactoring suggestions
- Architecture recommendations and best practices

### Advanced Debugging Assistant
- Analyze error messages and stack traces
- Identify performance bottlenecks
- Security vulnerability detection

### Professional Terminal Experience
- Syntax highlighting for all major programming languages
- Interactive menus and command suggestions
- Progress indicators for long-running operations
- Rich formatting with colors and visual feedback

## Configuration

### Environment Setup
Set your Anthropic API key:
```bash
export ANTHROPIC_API_KEY="your-api-key-here"
```

Or create a `.env` file in your project:
```
ANTHROPIC_API_KEY=your-api-key-here
```

### Command Line Options
```bash
zen-cli [options]

Options:
  -d, --directory <path>   Working directory
  --api-key <key>         Anthropic API key
  -h, --help              Show help
```

### MCP Integration
Zen CLI supports MCP (Model Context Protocol) servers for extended functionality:

```json
{
  "enabled": true,
  "servers": [
    {
      "name": "figma",
      "command": "npx",
      "args": ["-y", "figma-developer-mcp"],
      "description": "Figma design integration"
    }
  ]
}
```

## Use Cases

**Frontend Development**
- Generate React/Vue components with TypeScript
- CSS styling and responsive design assistance
- State management setup and optimization

**Backend Development**
- API design and implementation
- Database schema design and migrations
- Authentication and authorization systems

**DevOps & Infrastructure**
- Docker containerization strategies
- CI/CD pipeline configuration
- Infrastructure as Code templates

**Full-Stack Projects**
- End-to-end application architecture
- Technology stack recommendations
- Code review and quality assurance

## System Requirements

- Node.js 18.0.0 or higher
- NPM 7.0.0 or higher
- 512MB RAM minimum
- macOS, Linux, Windows (WSL recommended)

## Reporting Issues

We welcome feedback and bug reports. Use the built-in feedback commands within Zen CLI, or file a [GitHub issue](https://github.com/yuvakiran-zen/zen-cli/issues).

## Privacy and Security

### Data Handling
- **Local Processing**: Configuration and sensitive data stays on your machine
- **Secure API Communication**: Encrypted communication with Anthropic's API
- **No Training Data**: Your code is not used to train AI models
- **Minimal Data Collection**: Only essential usage analytics

### Privacy Safeguards
- Limited retention periods for API requests
- Restricted access to user session data
- Clear policies against using code for model training
- Local configuration management

For full details, please review our privacy practices and terms of service.

## License

Proprietary - Commercial software by Zen Team. All rights reserved.