# Installation

Armorer is a standard Python application that can be installed globally (recommended) or locally.

## Prerequisites

- **Python 3.12+**
- **Docker** (Required for running agents)
- **uv** (Recommended package manager)

## Global Installation (Recommended)

Installing Armorer as a tool makes it available from any directory while keeping its dependencies isolated.

```bash
uv tool install .
```

Verify the installation:
```bash
armorer --help
```

## Local Development

If you are contributing to Armorer, you can run it from the source directory.

1.  Clone the repository:
    ```bash
    git clone https://github.com/secureneural/armorer.git
    cd armorer
    ```

2.  Sync dependencies:
    ```bash
    uv sync
    ```

3.  Run via `uv`:
    ```bash
    uv run armorer --help
    ```
## Configuration

Armorer supports multiple LLM providers. After installation, run:

```bash
armorer config
```

### Supported Providers
- **OpenAI** (default)
- **Anthropic**
- **Google Gemini**
- **AWS Bedrock**
- **OpenRouter**
- **Ollama** (Local Models)

### Ollama Setup
To use a local model via Ollama:
1. Ensure Ollama is running (`ollama serve`).
2. Run `armorer config` -> **Change Model** -> **ollama**.
3. Specify your model (e.g., `llama3.2`).
4. (Optional) Customize the Base URL (default: `http://localhost:11434/v1/`).
