Getting StartedInstallation

Installation

Get Copinance OS installed and ready to use.

Prerequisites

  • Python 3.11 or higher
  • make (optional, but recommended)

Quick Installation

Recommended (with make):

git clone https://github.com/copinance/copinance-os.git
cd copinance-os
make setup

This will:

  • Create a virtual environment
  • Install all dependencies
  • Set up pre-commit hooks

Manual installation:

git clone https://github.com/copinance/copinance-os.git
cd copinance-os
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

Verify Installation

copinance version
# or
python -m copinanceos.cli version

Expected output:

Copinance OS v0.1.0

Optional Dependencies

For local LLM support (Ollama):

pip install -e ".[ollama]"

Note: Documentation uses Nextra and is located in the docs/ directory. See the documentation README for building the documentation locally.

No Installation Needed

You can run the CLI directly without installing:

python -m copinanceos.cli version

Next Steps

HomeQuick Start