Installation

Get set-me-up installed and running on your system in minutes

Prerequisites

Make sure you have these ready before installing

Operating System

macOS (10.14 or later) or Debian-based Linux (Ubuntu, Debian, etc.)

Command Line Access

Terminal or command-line interface for executing installation commands

Internet Connection

Active internet connection for downloading packages and dependencies

Admin Privileges

Administrator access for installing Homebrew and system packages

Quick Install (Recommended)

The easiest way to get started with set-me-up

bash <(curl -s -L https://raw.githubusercontent.com/dotbrains/set-me-up-installer/main/install.sh)

What this does:

1

Downloads the set-me-up installer script

2

Clones the installer repository to ~/.set-me-up

3

Makes the smu command available in your PATH

4

Sets up the necessary directory structure

Alternative Installation Methods

Choose the method that works best for your workflow

Custom Installation Directory

Install set-me-up to a custom location using the SMU_HOME_DIR environment variable

SMU_HOME_DIR=~/my-custom-location bash <(curl -s -L https://raw.githubusercontent.com/dotbrains/set-me-up-installer/main/install.sh)

Replace ~/my-custom-location with your preferred installation path

Manual Installation

For complete control over the installation process

1

Clone the repository

git clone https://github.com/dotbrains/set-me-up-installer.git ~/.set-me-up

2

Add smu to your PATH

# For bash/zsh
echo 'export PATH="$HOME/.set-me-up:$PATH"' >> ~/.bashrc

# For fish
echo 'set -gx PATH $HOME/.set-me-up $PATH' >> ~/.config/fish/config.fish

3

Reload your shell

# For bash
source ~/.bashrc

# For zsh
source ~/.zshrc

# For fish
source ~/.config/fish/config.fish

Recommended

Using the Blueprint Template

Fork the blueprint repository for a fully customizable, version-controlled setup

1

Fork the blueprint

Fork set-me-up-blueprint on GitHub to your account

2

Clone your fork

git clone https://github.com/YOUR_USERNAME/set-me-up-blueprint.git ~/set-me-up-blueprint

3

Set SMU_HOME_DIR

export SMU_HOME_DIR=~/set-me-up-blueprint
# Add to your shell configuration to make it permanent

Why Blueprint? Keep your dotfiles in version control, easily sync across machines, and customize everything to your preferences.

Verify Installation

Confirm that set-me-up is installed correctly

smu --help

You should see the help output with available commands and options

What Gets Installed?

~/.set-me-up/
├── install.sh          # Installation script
├── smu                 # Main command script
└── smu.py             # Python helper script

Troubleshooting

Common issues and their solutions

Permission Errors

If you encounter permission errors during installation:

# Ensure you have write access to the installation directory
mkdir -p ~/.set-me-up
chmod 755 ~/.set-me-up

Command Not Found

If smu command is not found after installation:

• Verify the installation directory exists
• Check that the PATH is correctly set
• Restart your terminal or reload your shell configuration

SSL Certificate Errors

If you encounter SSL certificate errors during download:

# Update CA certificates (macOS)
brew install ca-certificates

# Update CA certificates (Debian/Ubuntu)
sudo apt-get update && sudo apt-get install -y ca-certificates

Next Steps

Now that set-me-up is installed, you're ready to configure your development environment

Get Started Explore Modules