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.

This guide walks you through installing Aurora Shell, completing the one-time setup wizard, and taking your first steps with the diagnostics banner, the shell.aurora command center, the built-in package manager, and the AI assistant. By the end you will have a fully themed terminal with live system stats, a rainbow prompt, and a working CLI installer — all in under five minutes.
1

Install Aurora Shell

Run the one-line installer for your platform. The script bootstraps all dependencies and immediately launches the configuration wizard.
bash <(curl -s https://raw.githubusercontent.com/Seaus-tech/Aurora-Shell/main/install.sh)
On macOS, Homebrew is installed automatically if missing, followed by figlet, lolcat, and pygments. On Windows, ensure you are running this inside PowerShell 7 (pwsh) — not Windows PowerShell 5.1.
2

Complete the Setup Wizard

Immediately after the environment sync, the installer launches the Aurora Configuration Wizard. You will be prompted for the following:
  • Terminal PIN — an optional PIN stored securely in macOS Keychain (or the Windows settings file). If set, you must enter it each time you open a new terminal session. Leave blank and press Enter to skip.
  • Header Style — enter 1 for Mega-Block (the large box-drawing font AURORA SHELL banner) or 2 for Custom Slant, which renders any name you type using figlet -f slant.
  • Prompt ID — a short label that appears in the rainbow prompt on every command line (e.g., your username or project name).
  • Birthday (MMDD) — a four-digit date such as 0314 used to show a birthday greeting when you open your terminal on that day.
Your choices are saved to ~/.aurora-shell_files/aurora-shell_settings and can be edited at any time with shell.aurora --config.
3

Restart Your Terminal

When the installer finishes, start a new shell session to load Aurora Shell for the first time:
# macOS
zsh

# Windows — open a new PowerShell 7 window, or reload your profile in the current one
. $PROFILE
You will see the full Aurora Shell startup sequence:
  1. If you set a PIN, the session-lock screen appears first — enter your PIN to proceed.
  2. The ASCII art banner renders in the center of your terminal (rainbow-colored on macOS via lolcat).
  3. A stats line shows below the banner: version, live CPU usage, free disk space, battery percentage (macOS), and today’s date.
  4. A full-width separator line marks the end of the header.
  5. The rainbow prompt appears, ready for your first command.
4

Run Your First Command

Type shell.aurora with no arguments to open the Aurora Command Center menu and see all available flags:
shell.aurora
The following flags are available:
FlagDescription
--displayRe-render the ASCII art banner and live stats
--sysPrint OS and CPU information
--update [branch]Re-run the installer to update Aurora Shell (defaults to main)
--configOpen aurora-shell_settings in your editor
--lockLock the terminal and require PIN re-entry
--uninstallRemove all Aurora Shell files and the .zshrc source line
--accountManage your Aurora account (create, login, logout, link services)
5

Install a CLI Package

Aurora Shell includes a two-tier package manager. First, install the Aurora CLI tool from the Aurora registry:
shell install CLI
This writes the CLI command to ~/.aurora-shell_files/bin/ and adds it to your PATH. Now use CLI install to install any supported developer CLI. For example, to install the GitHub CLI:
CLI install GitHub
The CLI installer fetches the latest package list from GitHub, runs the appropriate install command (brew install gh on macOS, winget install GitHub.cli on Windows), and confirms success. You can also run:
CLI list      # show all available CLI packages
CLI search <query>   # search packages by name or alias
6

Try the AI Assistant (Optional)

Aurora Shell ships with auseaia, a terminal AI assistant. Use it to ask questions, explain shell concepts, or debug commands without leaving your terminal:
auseaia "explain what a shell alias is"
auseaia requires additional setup before use. See the AI Assistant page for full configuration instructions before running this command.

​
Next Steps

Configuration

Edit your PIN, header style, prompt ID, and birthday. Learn how to open and modify aurora-shell_settings directly.

Package Manager

Explore the full shell command — install DMGs, add custom packages, search the Aurora registry, and manage installed tools.

AI Assistant

Configure the auseaia command for in-terminal AI help, alias explanations, and interactive debugging — right where you work.

Command Reference

A complete reference for every shell.aurora, shell, and CLI flag and subcommand with examples.

Build docs developers (and LLMs) love

Get started for freeTalk to us