Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Seaus-tech/Aurora-Shell/llms.txt

Use this file to discover all available pages before exploring further.

The Aurora Shell installer handles everything in one pass: it syncs your environment (installing Homebrew and required dependencies on macOS, or verifying PowerShell 7+ on Windows), runs an interactive configuration wizard to capture your PIN, header style, prompt ID, and birthday, generates a theme file at ~/.aurora-shell_files/aurora-shell_theme, and sources that file into your shell profile so the dashboard activates on every new terminal session.

​
Install Aurora Shell

​
Option 1: Command-Line Install

Paste the following into any macOS Terminal (Zsh). The script will bootstrap Homebrew if it is missing, install dependencies, and run the setup wizard:
bash <(curl -s https://raw.githubusercontent.com/Seaus-tech/Aurora-Shell/main/install.sh)

​
Option 2: DMG Installer

  1. Download the latest release from https://github.com/Seaus-tech/Aurora-Shell-2/releases/latest
  2. Open the .dmg file
  3. Open Terminal and follow the on-screen installer prompts
  4. Restart your terminal when the installer completes

​
Dependencies

Aurora Shell requires lolcat, figlet, and pygments on macOS. The command-line installer installs them automatically:
brew install figlet lolcat pygments
If you use the DMG installer and the banner appears without color, run the command above manually.

​
What the Installer Does

1

Sync Environment

On macOS, the installer checks whether Homebrew is present and installs it under $HOME/.brew if missing. It then installs the required packages:
brew install figlet lolcat pygments
On Windows, the environment sync verifies that PowerShell 7+ is the active shell and that the $HOME\.aurora-shell_files directory and bin subdirectory exist.
2

Dev Tools Bootstrap (Optional)

The installer offers an optional interactive bootstrap for common developer tools. On macOS, you are prompted one by one for each of the following:
  • Git, GitHub CLI, Node.js, Python 3, Java (OpenJDK), Go, Rust, Docker Desktop, AWS CLI, Azure CLI
Answer y to install any tool via Homebrew (or Xcode Command Line Tools for Git). Press Enter or answer n to skip. On Windows, the equivalent tools are available via winget after installation through the CLI installer.
3

Configuration Wizard

The installer runs an interactive wizard that records your preferences and saves them to ~/.aurora-shell_files/aurora-shell_settings:
  • Terminal PIN — stored securely in macOS Keychain (or as plain text in the Windows settings file). Used to lock and unlock your terminal via shell.aurora --lock.
  • Header Style — choose 1 for Mega-Block (large box-drawing font banner) or 2 for Custom Slant (a custom name rendered with figlet -f slant).
  • Prompt ID — a label displayed in the rainbow prompt on every command line.
  • Birthday (MMDD) — a four-digit date used to display a birthday greeting when you open your terminal on that day.
4

Generate Theme File

The installer writes the complete Aurora Shell theme engine to:
  • macOS: ~/.aurora-shell_files/aurora-shell_theme
  • Windows: $HOME\.aurora-shell_files\aurora-shell_theme.ps1
This file contains the Show-Aurora diagnostics function, the authenticate_user session-lock function, the shell.aurora command center, the shell package manager, and the rainbow prompt definition.
5

Source into Shell Profile

The installer appends a source line to your shell profile so Aurora loads on every new session:
  • macOS (~/.zshrc): 
    source ~/.aurora-shell_files/aurora-shell_theme
  • Windows ($PROFILE): 
    Get-ChildItem "$HOME\.aurora-shell_files\*.ps1" | ForEach-Object { . $_.FullName }
Any previous Aurora source line is removed before the new one is added to avoid duplicates.
6

Clone Aurora Shell Repo for Assets

The installer searches your home folder for an existing Aurora Shell Git clone. If found, it runs git pull to update it. If not found, it clones the repository fresh into ~/.aurora-shell_files/aurora-shell/. Two asset files are copied into place after cloning:
  • brew-progress.py — renders a progress bar during Homebrew installations
  • spinner.js — displays a braille spinner animation during CLI package installs

​
Post-Install

Once the installer completes, restart your terminal or start a new shell session to activate Aurora: 
# macOS — start a new Zsh session
zsh

# Windows — open a new PowerShell 7 window or reload your profile
. $PROFILE
You should see the ASCII art banner, the live system stats line, and the rainbow prompt. If the banner appears without color on macOS, ensure lolcat is on your PATH by running which lolcat.

Build docs developers (and LLMs) love

Get started for freeTalk to us