File size: 1,685 Bytes
a7d7463 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | """Documentation: Installation Guide"""
# Installation Guide - Burme-Coder-Max
## Prerequisites
- Python 3.8 or higher
- pip package manager
## Installation Methods
### Method 1: pip install (Recommended)
```bash
pip install burme-coder-max
```
### Method 2: From source
```bash
git clone https://github.com/amkyawdev/burme-coder-max.git
cd burme-coder-max
pip install -e .
```
### Method 3: Development install
```bash
git clone https://github.com/amkyawdev/burme-coder-max.git
cd burme-coder-max
pip install -e ".[dev]"
```
## Verify Installation
```bash
burme-coder --version
```
Expected output:
```
burme-coder-max 1.0.0
```
## Configuration
1. Copy `.env.example` to `.env`:
```bash
cp .env.example .env
```
2. Edit `.env` with your settings:
```bash
nano .env
```
### Required Environment Variables
| Variable | Description | Required |
|----------|-------------|----------|
| OPENAI_API_KEY | OpenAI API key for AI responses | Yes |
| DATABASE_URL | Database connection string | No |
## Dependencies
See `requirements.txt` for full dependency list.
Main dependencies:
- click >= 8.0.0
- rich >= 13.0.0
- requests >= 2.28.0
- pydantic >= 2.0.0
## Troubleshooting
### Installation fails
- Check Python version: `python --version`
- Upgrade pip: `pip install --upgrade pip`
- Try in virtual environment
### Module not found
- Reinstall: `pip install --force-reinstall burme-coder-max`
- Check PATH
### Permission denied
- Use `--user` flag: `pip install --user burme-coder-max`
- Or use virtual environment
## Uninstall
```bash
pip uninstall burme-coder-max
```
## Next Steps
See [usage.md](usage.md) for how to use burme-coder-max.
|