> For the complete documentation index, see [llms.txt](https://docs.openmm.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openmm.io/getting-started/installation.md).

# Installation

## NPM Package

```bash
npm install -g @3rd-eye-labs/openmm
```

## From Source

```bash
git clone https://github.com/3rd-Eye-Labs/OpenMM.git
cd OpenMM
npm install
npm run build
npm install -g .
```

## Verify Installation

```bash
openmm --version
openmm --help
```

## Exchange Setup

Run the interactive setup wizard:

```bash
openmm setup
```

This will guide you through:

1. Selecting exchanges to configure
2. Entering API credentials
3. Testing connectivity

### Manual Configuration

Create a `.env` file in your working directory:

```env
# MEXC (required)
MEXC_API_KEY=your-api-key
MEXC_SECRET=your-secret-key

# Gate.io (optional)
GATEIO_API_KEY=your-api-key
GATEIO_SECRET_KEY=your-secret-key

# Bitget (optional)
BITGET_API_KEY=your-api-key
BITGET_SECRET_KEY=your-secret-key
BITGET_PASSPHRASE=your-passphrase

# Kraken (optional)
KRAKEN_API_KEY=your-api-key
KRAKEN_SECRET_KEY=your-secret-key
```

## MCP Server

For AI agent integration:

```bash
npm install -g @qbtlabs/openmm-mcp
npx @qbtlabs/openmm-mcp setup
```

See [MCP documentation](https://github.com/QBT-Labs/openMM-MCP) for client configuration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openmm.io/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.