Installation

Get Linear Canal running in under two minutes.

Prerequisites

Linear Canal is a Python tool. You need the following before installing:

  • Python 3.11 or later
  • pip (comes with Python)
  • Git (for repository analysis)

Install via pip

Install the CLI globally so it's available in any project.

bash
pip install linear-canal

Install from Source

To run the latest development version:

bash
git clone https://github.com/linear-canal/linear-canal.git
cd linear-canal
pip install -e .

Verify Installation

bash
linear-canal --version

Next, follow the Quick Start guide to index your first codebase.

Next
Quick Start