Installation

This guide covers the installation of SpecAlign on various platforms.

Requirements

  • Python 3.9 or higher

  • pip package manager

  • OpenAI API key (or compatible provider)

Installation Methods

From Git Repository

pip install git+https://github.com/your-org/specalign.git

For Development

git clone https://github.com/your-org/specalign.git
cd specalign
pip install -e ".[dev]"

Verify Installation

After installation, verify that SpecAlign is correctly installed:

specalign --version

You should see output similar to:

SpecAlign version 1.0.0

Dependencies

SpecAlign depends on the following packages:

Package

Purpose

typer

CLI framework

openai

OpenAI API client

pydantic

Data validation

rich

Terminal formatting

numpy

Numerical operations

httpx

HTTP client

Next Steps