@clyde-code-ai/clyde-code/README.md

A CLI AI code assistant.

```
> clyde-code

 ██████╗██╗  ██╗   ██╗██████╗ ███████╗     ██████╗ ██████╗ ██████╗ ███████╗
██╔════╝██║  ╚██╗ ██╔╝██╔══██╗██╔════╝    ██╔════╝██╔═══██╗██╔══██╗██╔════╝
██║     ██║   ╚████╔╝ ██║  ██║█████╗      ██║     ██║   ██║██║  ██║█████╗  
██║     ██║    ╚██╔╝  ██║  ██║██╔══╝      ██║     ██║   ██║██║  ██║██╔══╝  
╚██████╗███████╗██║   ██████╔╝███████╗    ╚██████╗╚██████╔╝██████╔╝███████╗
 ╚═════╝╚══════╝╚═╝   ╚═════╝ ╚══════╝     ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝
    
Welcome to Clyde Code! Type 'bye' to exit.


Clyde> Hi!
================================== Ai Message ==================================

Hello! How can I assist you today?

Clyde> quit
```

Clyde is an open-source coding assistant that works with closed and open-source models.

## Tested models:
- gpt-4o
- Qwen3

## Requirements

- Python 3.12+
- Node.js
- OpenAI API key or compatible LLM API

## Installation

### Option 1: Install via npm (Recommended)

```bash
# Install via npm
npm install @clyde-code-ai/clyde-code
```

This will automatically:
- Install the Python package in an isolated environment using pipx or uv
- Create a config file at `~/.clyde-code/config.json` with placeholders
- You must add your api key to `~/.clyde-code/config.json`!
- Make the `clyde-code` command available in your project

**Requirements for npm installation:**
- Node.js 16+
- Python 3.12+
- pipx or uv (will be installed automatically if missing)

### Option 2: Install from source

```bash
# Install Node
# brew install node # Mac
# sudo apt install nodejs npm # Linux

# Clone the repository
git clone git@gitlab.com:nicholasbrawand/clyde_code.git
cd clyde_code

# Install with pip
pip install .

# Or install with uv (faster)
uv pip install .
```

## Configuration

Create `~/.clyde-code/config.json`:

```json
{
  "llm": {
    "model_name": "your-model-here",
    "api_key": "your-api-key-here",
    "base_url": "your-optional-url-here"
  },
  "agent": {
    "thread_id": "main"
  }
}
```

## Usage

After installation, run Clyde Code from any directory:

```bash
clyde-code
```

### Commands

- Type `bye`, `exit`, or `quit` to exit

## Uninstall

### If installed via npm:
```bash
npm uninstall @clyde-code-ai/clyde-code
```

### If installed from source or manually:
```bash
# If installed with pipx
pipx uninstall clyde-code

# If installed with uv
uv tool uninstall clyde-code

# If installed with pip
pip uninstall clyde-code
```

The config file at `~/.clyde-code/config.json` will remain - delete manually if desired.