Installation

The Algebras CLI can be installed using pip, pipx, or other Python package managers. Choose the method that works best for your environment.

Prerequisites

• Python 3.12 or higher
• pip (Python package installer)

Installation Methods

Method 1: Using pip (Recommended)

pip install git+https://github.com/algebras-ai/algebras-cli.git

Method 2: Using pipx (Isolated Environment)

If you prefer to install CLI tools in isolated environments:

pipx install algebras-cli

Method 3: Using pip with —user flag

For user-only installation (no admin privileges required):

pip install --user algebras-cli

Method 4: From Source (Development)

If you want to install the latest development version:

git clone https://github.com/algebras-ai/algebras-cli.git
cd algebras-cli
pip install -e .

Verify Installation

After installation, verify that the CLI is working:

algebras --version

You should see output like:

algebras-cli version 1.0.0

Getting Your API Key

Before you can use the Algebras CLI, you’ll need an API key to authenticate with the Algebras platform.

Step 1: Sign Up or Log In

1. Visit the Algebras platform
2. Sign up for a new account or log in to your existing account

Step 2: Create an API Key

1. Navigate to the API Keys page
2. Click “Create API Key” or “New API Key”
3. Give your API key a descriptive name (e.g., “CLI Development Key”)
4. Copy your API key immediately - you won’t be able to see it again!

Keep your API key secure! Never commit it to version control or share it publicly. Treat it like a password.

Step 3: Set Your API Key

Set the API key as an environment variable in your terminal:

Linux/macOS:

export ALGEBRAS_API_KEY=your_api_key_here

Windows (Command Prompt):

set ALGEBRAS_API_KEY=your_api_key_here

Windows (PowerShell):

$env:ALGEBRAS_API_KEY="your_api_key_here"

Step 4: Make Your API Key Persistent (Optional)

To avoid setting the API key every time you open a new terminal:

Linux/macOS (bash):

echo 'export ALGEBRAS_API_KEY=your_api_key_here' >> ~/.bashrc
source ~/.bashrc

Linux/macOS (zsh):

echo 'export ALGEBRAS_API_KEY=your_api_key_here' >> ~/.zshrc
source ~/.zshrc

Windows (Permanent): Add it as a system environment variable through System Properties.

Note

For production environments, consider using a secrets manager or environment variable management tool instead of hardcoding the key.

Platform-Specific Instructions

Windows

1. Open Command Prompt or PowerShell
2. Run: pip install git+https://github.com/algebras-ai/algebras-cli.git
3. Verify: algebras --version

macOS

1. Open Terminal
2. Run: pip install git+https://github.com/algebras-ai/algebras-cli.git
3. Verify: algebras --version

Linux (Ubuntu/Debian)

1. Open Terminal
2. Run: pip install git+https://github.com/algebras-ai/algebras-cli.git
3. Verify: algebras --version

Note

On some Linux distributions, you may need to use pip3 instead of pip.

Troubleshooting Installation

”command not found: algebras”

Cause: The CLI wasn’t added to your PATH.

Solutions:

1. Restart your terminal after installation
2. Add pip user bin to PATH:

   echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
   source ~/.bashrc

3. Use full path:

   python -m algebras --version

Permission Denied Errors

Cause: Insufficient permissions to install packages globally.

Solutions:

1. Use —user flag:

   pip install --user algebras-cli

2. Use virtual environment:

   python -m venv algebras-env
   source algebras-env/bin/activate  # On Windows: algebras-env\Scripts\activate
   pip install git+https://github.com/algebras-ai/algebras-cli.git

Python Version Issues

Cause: Using an outdated Python version.

Solutions:

1. Check Python version:

   python --version

2. Upgrade Python to version 3.8 or higher
3. Use specific Python version:

   python -m pip install git+https://github.com/algebras-ai/algebras-cli.git

Next Steps

Once you have the CLI installed:

1. Configure your project - Set up your .algebras.config
2. Learn the commands - Understand available CLI commands
3. Try advanced features - Explore glossaries, batch processing, and more

Uninstalling

To remove the Algebras CLI:

pip uninstall algebras-cli

Or if installed with pipx:

pipx uninstall algebras-cli