Installation Guide

This guide will walk you through installing Andromeda on your system.

Prerequisites

Andromeda requires:

Quick Install

Linux/macOS (Bash)

curl -fsSL https://tryandromeda.dev/install.sh | bash

Or download and run manually:

wget https://tryandromeda.dev/install.sh
chmod +x install.sh
./install.sh

Windows (PowerShell)

irm -Uri "https://tryandromeda.dev/install.ps1" | Invoke-Expression

Windows (Command Prompt)

curl -L -o install.bat https://tryandromeda.dev/install.bat && install.bat

Other Installation Methods

The easiest way to install Andromeda is using Cargo to install directly from the Git repository:

cargo install --git https://github.com/tryandromeda/andromeda

This will:

  1. Download the latest source code
  2. Compile Andromeda with optimizations
  3. Install the andromeda binary to your Cargo bin directory

Method 2: Build from Source

If you want to build from source or contribute to development:

  1. Clone the repository:

    git clone https://github.com/tryandromeda/andromeda.git
    cd andromeda
  2. Build the project:

    cargo build --release
  3. Install locally:

    cargo install --path cli

Verify Installation

After installation, verify that Andromeda is working correctly:

# Check version
andromeda --version

# Start the REPL
andromeda repl

# Run a simple test
echo 'console.log("Hello, Andromeda!");' > test.js
andromeda run test.js

Setting up Your Environment

Adding to PATH

Cargo typically installs binaries to ~/.cargo/bin (Unix) or %USERPROFILE%\.cargo\bin (Windows). Make sure this directory is in your system's PATH.

On Unix-like systems (Linux, macOS)

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

On Windows

Add %USERPROFILE%\.cargo\bin to your system PATH through:

  1. System Properties → Advanced → Environment Variables
  2. Edit the PATH variable
  3. Add the Cargo bin directory

Shell Completion (Optional)

Andromeda supports shell completion for bash, zsh, fish, and PowerShell. Generate completion scripts:

# For bash
andromeda completions bash > ~/.local/share/bash-completion/completions/andromeda

# For zsh
andromeda completions zsh > ~/.oh-my-zsh/completions/_andromeda

# For fish
andromeda completions fish > ~/.config/fish/completions/andromeda.fish

# For PowerShell
andromeda completions powershell > andromeda.ps1

Platform-Specific Notes

Windows

macOS

Linux

Troubleshooting

Common Issues

"andromeda: command not found"

Build failures on installation

Permission errors

Getting Help

If you encounter issues:

  1. Check the Troubleshooting Guide
  2. Search GitHub Issues
  3. Ask for help on Discord

Next Steps

Now that Andromeda is installed:

  1. Read the Quick Start Guide
  2. Explore the CLI Reference
  3. Join our Discord community

Updating Andromeda

Andromeda includes a built-in upgrade system for easy updates:

Automatic Upgrade

# Upgrade to latest version
andromeda upgrade

# Check what would be upgraded (dry run)
andromeda upgrade --dry-run

# Force reinstall current version
andromeda upgrade --force

# Upgrade to specific version
andromeda upgrade --version v0.2.0

Manual Update

To update manually using Cargo:

cargo install --git https://github.com/tryandromeda/andromeda --force

The --force flag will overwrite the existing installation with the latest version.

Upgrade Features

The built-in upgrade system provides: