Installation¶

Get PortableRalph up and running in under a minute.

One-Liner Install¶

The fastest way to get started:

curl -fsSL https://raw.githubusercontent.com/aaron777collins/portableralph/master/install.sh | bash

This will:

Clone PortableRalph to ~/ralph
Set up the ralph alias in your shell
Optionally configure notifications

Manual Installation¶

If you prefer manual setup:

# Clone the repository
git clone https://github.com/aaron777collins/portableralph.git ~/ralph

# Make scripts executable
chmod +x ~/ralph/*.sh

# Add alias to your shell
echo 'alias ralph="~/ralph/ralph.sh"' >> ~/.bashrc
source ~/.bashrc

Headless Installation¶

For CI/CD or automated setups, use command-line flags:

# Install with Slack notifications
curl -fsSL https://raw.githubusercontent.com/aaron777collins/portableralph/master/install.sh | \
  bash -s -- --headless --slack-webhook "https://hooks.slack.com/services/xxx"

# Install with Discord
curl -fsSL https://raw.githubusercontent.com/aaron777collins/portableralph/master/install.sh | \
  bash -s -- --headless --discord-webhook "https://discord.com/api/webhooks/xxx"

# Install with custom script
curl -fsSL https://raw.githubusercontent.com/aaron777collins/portableralph/master/install.sh | \
  bash -s -- --headless --custom-script "/path/to/notify.sh"

Headless Flags¶

Flag	Description
`--headless`	Non-interactive mode
`--slack-webhook URL`	Configure Slack webhook
`--discord-webhook URL`	Configure Discord webhook
`--telegram-token TOKEN`	Configure Telegram bot token
`--telegram-chat ID`	Configure Telegram chat ID
`--custom-script PATH`	Configure custom notification script

Requirements¶

Before installing, make sure you have:

Requirement	Description
Claude Code CLI	Install from Anthropic
Bash	Most Unix systems have this
Git	For auto-commits (optional)
curl	For notifications (optional)

Verify Claude CLI¶

claude --version

If this doesn't work, install Claude Code first.

Post-Installation¶

Verify Installation¶

ralph --version

Set Up Notifications (Optional)¶

ralph notify setup

Test Notifications¶

ralph notify test

Upgrading¶

Ralph has a built-in self-update system for easy upgrades:

# Update to the latest version
ralph update

# Check for updates without installing
ralph update --check

# List all available versions
ralph update --list

# Install a specific version
ralph update 1.5.0

Rollback¶

If an update causes issues, you can rollback to the previous version:

ralph rollback

The previous version is automatically backed up before each update to ~/.ralph_backup/.

Version History¶

Your update history is tracked in ~/.ralph_version_history.

Uninstalling¶

To remove PortableRalph:

# Remove the directory
rm -rf ~/ralph

# Remove the alias from your shell config
# Edit ~/.bashrc or ~/.zshrc and remove the ralph alias line

# Remove config file (optional)
rm ~/.ralph.env