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 configuration wizard runs automatically at the end of install.sh (macOS) and install.ps1 (Windows). It walks you through every personalisation option in one guided session and writes all values to a persistent settings file. If you want to revisit any setting, simply re-run the installer — the wizard will read the existing file and let you overwrite individual values.

What the Wizard Configures

The wizard prompts you for five pieces of information in the following order.

1. Terminal PIN

🔐 Set Terminal PIN (Enter for none):
When you open a new terminal session Aurora presents a lock screen and requires this PIN before displaying the dashboard. On macOS the PIN is stored in your login Keychain via:
security add-generic-password -a "$USER" -s "aurora-shell-pin" -w "$NEW_PW" -U
On Windows the PIN is stored as $AURORA_PW in plain text inside aurora-shell_settings.ps1. Leave the field empty and press Enter to disable the lock screen entirely — Aurora will skip authentication on startup.

2. Header Style

🎨 1) Mega-Block  2) Custom Slant
Choose how the banner is rendered each time you open a terminal:
OptionmacOS labelWindows labelBehaviour
1Mega-BlockMega-BlockRenders the hardcoded Unicode block-art AURORA SHELL banner
2Custom SlantCustom TextmacOS: renders your text via figlet -f slant piped through lolcat. Windows: renders your text via the built-in ConvertTo-ASCIIArt function

3. Header Name

✍️ Header Name:
This prompt only appears when you select option 2 (Custom Slant / Custom Text). Enter the text you want rendered as the banner title — for example dev-station or your own name. The value is stored as AURORA_HDR_VAL and passed to figlet (macOS) or ConvertTo-ASCIIArt (Windows) on every terminal open.

4. Birthday (MMDD)

🎂 Birthday (MMDD):
Enter your birthday as a four-digit string in MMDD format — for example 0314 for 14 March. The value is stored as AURORA_USER_BDAY in the settings file. Aurora uses this for themed greetings.

5. Prompt ID

🆔 Prompt ID:
The Prompt ID is a short label that is prepended to every shell prompt. It is stored as AURORA_ID and inserted into the Zsh rainbow prompt template as:
${AURORA_ID} %n@%m %* >
For example, setting AURORA_ID to admin produces a prompt that reads admin username@hostname 12:34:56 > (rendered in a rolling rainbow gradient).

Account Sign-In (Optional, macOS only)

After the five core prompts the macOS wizard offers an optional Aurora account step. The Windows installer (install.ps1) does not include this step — use shell.aurora --account --login after installation to sign in on Windows.
🌐 Aurora Account (optional — syncs your profile across machines)
   Sign in? (y/n/create):
ResponseBehaviour
ySign in to an existing account — prompts for username and password
createCreate a new account — prompts for username and a confirmed password
(anything else / Enter)Skip — Aurora works fully offline without an account
On a successful sign-in, your account username is written to AURORA_ID so your prompt matches your account identity across machines. For full details on account management see the Accounts page.

The Settings File

All wizard answers are persisted in a single plain-text settings file. Aurora sources this file on every terminal launch.
PlatformPath
macOS~/.aurora-shell_files/aurora-shell_settings
Windows~/.aurora-shell_files/aurora-shell_settings.ps1
The file contains the following variables:
AURORA_VER="5.6.2"
AURORA_HDR_MODE="BLOCK"
AURORA_HDR_VAL="Aurora-Shell"
AURORA_USER_BDAY="0314"
AURORA_ID="admin"
On Windows the same variables are written as PowerShell assignments:
$AURORA_VER = "5.5.7"
$AURORA_PW = ""
$AURORA_HDR_MODE = "BLOCK"
$AURORA_HDR_VAL = "Aurora-Shell"
$AURORA_USER_BDAY = "0314"
$AURORA_ID = "admin"
You can edit any value directly in a text editor at any time — the change takes effect the next time you open a terminal or re-source the file.
Open the settings file directly in your default editor with shell.aurora --config. On macOS this opens Xcode (or falls back to $EDITOR). On Windows this opens Notepad.

Build docs developers (and LLMs) love