Skip to Content
Alprina is in active development. Join us in building the future of security scanning.
Getting StartedInstallation

Installation

Get Alprina installed on your system in minutes. Alprina works on macOS, Linux, Windows, and Docker.

Prerequisites

  • Python 3.10+ - Alprina requires Python 3.10 or higher
  • pip - Python package manager (usually included with Python)
  • Git (optional) - For development installation
  • API Key (optional) - Only needed for remote scanning

Check your Python version:

python --version
# or
python3 --version

🚀 Quick Install

macOS / Linux

curl -fsSL https://api.alprina.com/install.sh | sh

Or the shorthand version:

curl -fsSL https://api.alprina.com/cli | sh

Windows (PowerShell)

iwr https://api.alprina.com/install.ps1 -useb | iex

Install via pip (Alternative)

If you prefer to use pip:

pip install alprina-cli

Or with Python 3 explicitly:

pip3 install alprina-cli

Verify Installation

Check that Alprina is installed correctly:

alprina --version

Expected output:

Alprina CLI version 0.2.2

Test the CLI is working:

alprina --help

You should see the help menu with all available commands.

Platform-Specific Installation

macOS

Option 1: Using pip (Recommended)

# Install with pip
pip3 install alprina-cli
 
# Verify
alprina --version

Option 2: Using Homebrew

# Add Alprina tap
brew tap alprina/tap
 
# Install
brew install alprina-cli
 
# Verify
alprina --version

Option 3: Using pipx (Isolated Environment)

# Install pipx if you don't have it
brew install pipx
pipx ensurepath
 
# Install alprina-cli
pipx install alprina-cli
 
# Verify
alprina --version

Linux

Ubuntu / Debian

# Update package list
sudo apt update
 
# Install Python and pip
sudo apt install python3 python3-pip
 
# Install Alprina
pip3 install alprina-cli
 
# Add to PATH if needed
export PATH="$HOME/.local/bin:$PATH"
 
# Verify
alprina --version

Fedora / RHEL / CentOS

# Install Python and pip
sudo dnf install python3 python3-pip
 
# Install Alprina
pip3 install alprina-cli
 
# Verify
alprina --version

Arch Linux

# Install Python and pip
sudo pacman -S python python-pip
 
# Install Alprina
pip install alprina-cli
 
# Verify
alprina --version

Alpine Linux

# Install Python and pip
apk add --no-cache python3 py3-pip
 
# Install Alprina
pip3 install alprina-cli
 
# Verify
alprina --version

Windows

Option 1: Using pip

# Install with pip
python -m pip install alprina-cli
 
# Verify
alprina --version

Option 2: Using pipx

# Install pipx
python -m pip install pipx
python -m pipx ensurepath
 
# Restart your terminal, then:
pipx install alprina-cli
 
# Verify
alprina --version

Option 3: Using Scoop

# Install Scoop if you don't have it
# Then add Alprina bucket
scoop bucket add alprina https://github.com/alprina/scoop-bucket
 
# Install
scoop install alprina-cli
 
# Verify
alprina --version

Troubleshooting Windows

If alprina command is not found:

  1. Find your Python Scripts directory:

    python -c "import site; print(site.USER_BASE + '\\Scripts')"

  2. Add it to your PATH:

    • Open System Properties → Environment Variables
    • Edit PATH variable
    • Add the Scripts directory

Docker Installation

Run Alprina in an isolated Docker container.

Pull the Image

docker pull alprina/cli:latest

Run a Scan

# Scan current directory
docker run -v $(pwd):/workspace alprina/cli scan /workspace
 
# With authentication
docker run -e ALPRINA_API_KEY=your_key_here \
  -v $(pwd):/workspace \
  alprina/cli scan /workspace

Create an Alias

# Add to ~/.bashrc or ~/.zshrc
alias alprina='docker run -v $(pwd):/workspace alprina/cli'
 
# Then use normally
alprina scan ./src

Docker Compose

version: '3'
services:
  alprina:
    image: alprina/cli:latest
    volumes:
      - ./:/workspace
    environment:
      - ALPRINA_API_KEY=${ALPRINA_API_KEY}
    command: scan /workspace

Run with:

docker-compose run alprina scan /workspace

Development Installation

Install from source for development or latest features.

Clone the Repository

git clone https://github.com/alprina/alprina-cli.git
cd alprina-cli

Create Virtual Environment

# Create venv
python -m venv venv
 
# Activate (macOS/Linux)
source venv/bin/activate
 
# Activate (Windows)
venv\Scripts\activate

Install in Editable Mode

# Install dependencies
pip install -e .
 
# Install development dependencies
pip install -e ".[dev]"
 
# Verify
alprina --version

Using a virtual environment keeps Alprina isolated.

Create Virtual Environment

# Create venv
python -m venv alprina-env
 
# Activate (macOS/Linux)
source alprina-env/bin/activate
 
# Activate (Windows)
alprina-env\Scripts\activate
 
# Install Alprina
pip install alprina-cli
 
# When done, deactivate
deactivate

Upgrading Alprina

Upgrade to Latest Version

pip install --upgrade alprina-cli

Check for Updates

# Current version
alprina --version
 
# Available versions
pip index versions alprina-cli

Upgrade with pip

pip install --upgrade alprina-cli

Upgrade with Homebrew

brew upgrade alprina-cli

Upgrade Docker Image

docker pull alprina/cli:latest

Uninstalling Alprina

Remove with pip

pip uninstall alprina-cli

Remove with Homebrew

brew uninstall alprina-cli

Remove with pipx

pipx uninstall alprina-cli

Remove Docker Image

docker rmi alprina/cli

Troubleshooting

Command Not Found

Issue: alprina: command not found

Solution:

  1. Check Python’s bin directory is in PATH:

    echo $PATH | grep python

  2. Find where pip installed alprina:

    pip show -f alprina-cli

  3. Add to PATH:

    export PATH="$HOME/.local/bin:$PATH"

Permission Denied

Issue: Permission denied when installing

Solution:

# Use --user flag
pip install --user alprina-cli
 
# Or use pipx
pipx install alprina-cli

Python Version Error

Issue: Requires Python >=3.10

Solution:

# Check version
python3 --version
 
# Install newer Python if needed
# macOS
brew install python@3.11
 
# Ubuntu
sudo apt install python3.11

SSL Certificate Error

Issue: SSL errors during installation

Solution:

# Use trusted host
pip install --trusted-host pypi.org \
            --trusted-host files.pythonhosted.org \
            alprina-cli

System Requirements

Minimum Requirements

  • CPU: 1 core
  • RAM: 512 MB
  • Disk: 100 MB
  • OS: macOS 10.13+, Linux (kernel 3.10+), Windows 10+
  • CPU: 2+ cores
  • RAM: 2 GB
  • Disk: 500 MB
  • OS: macOS 12+, Linux (kernel 5.0+), Windows 11

Next Steps

After installing Alprina:

  1. Authenticate - Set up your API key (optional for local scans)
  2. Run Your First Scan - Try scanning a project
  3. Configure Alprina - Customize settings
  4. Read Command Reference - Learn all commands

Need Help?

Last updated on
Your First Security ScanQuick Start