Andromeda

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

Prerequisites

Andromeda requires:

Rust (latest stable version)
Git (for cloning the repository)

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

Method 1: Install from Git (Recommended)

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:

Download the latest source code
Compile Andromeda with optimizations
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:

Clone the repository:

git clone https://github.com/tryandromeda/andromeda.git
cd andromeda

Build the project:
```
cargo build --release
```
Install locally:
```
cargo install --path cli
```

Verify Installation

After installation, verify that Andromeda is working correctly:

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:

System Properties → Advanced → Environment Variables
Edit the PATH variable
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

Andromeda works on Windows 10/11 with PowerShell or Command Prompt
Some features may require Windows Subsystem for Linux (WSL) for full compatibility

macOS

Andromeda works on macOS 10.15+ (Catalina and later)
Apple Silicon (M1/M2) is fully supported

Linux

Most Linux distributions are supported
Requires glibc 2.31+ or musl 1.2.0+

Troubleshooting

Common Issues

"andromeda: command not found"

Ensure ~/.cargo/bin is in your PATH
Restart your terminal after installation

Build failures on installation

Update Rust: rustup update
Clear Cargo cache: cargo clean
Try installing with --force flag

Permission errors

On Unix systems, ensure you have write permissions to ~/.cargo/bin
On Windows, run as Administrator if needed

Getting Help

If you encounter issues:

Check the Troubleshooting Guide
Search GitHub Issues
Ask for help on Discord

Next Steps

Now that Andromeda is installed:

Read the Quick Start Guide
Explore the CLI Reference
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:

Cross-platform support: Works on Windows, macOS, and Linux
Safe upgrades: Creates automatic backups before upgrading
Version targeting: Upgrade to specific versions (e.g., v0.1.0-draft7)
Dry run mode: Preview upgrades without making changes
Auto-detection: Automatically detects your platform and architecture