Installation

Install Merlin CLI as a Python package and get ready for enterprise code analysis in under 2 minutes.

System Requirements

macOS

macOS 10.14+ (Mojave)
Python 3.8+

Linux

Ubuntu 18.04+, RHEL 7+
Python 3.8+

Windows

Windows 10+
Python 3.8+

Installation Methods

# Install with pipx (isolated environment)
pipx install merlin-cli

# Or install from source
pipx install git+https://github.com/stellradmin/merlin_cli.git

# Verify installation
merlin --version

# Upgrade when needed
pipx upgrade merlin-cli

Pro Tip

pipx is the recommended installation method as it creates an isolated environment for Merlin CLI, preventing dependency conflicts with your system Python packages.

Verify Installation

Check Version

Verify Merlin is installed and accessible

$ merlin --version

View Help

Display available commands and options

$ merlin --help

Test Analysis

Run a quick test on the current directory

$ merlin analyze . --dry-run

Troubleshooting

Python Version

Merlin CLI requires Python 3.8 or higher. Check your Python version:

$ python --version

Command Not Found

If merlin command is not found after pipx installation:

$ pipx ensurepath

Then restart your terminal or source your shell configuration file.

Need Help?

If you're still having issues, check our GitHub Issues or join our community for support.

What's Next?

Now that you have Merlin CLI installed, let's run your first code analysis.

Your First Analysis