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.

Every time you open a terminal, Aurora Shell’s Show-Aurora() function runs automatically and renders a live diagnostics snapshot directly below the ASCII art banner. The stats line is horizontally centered to your current terminal width and gives you an at-a-glance view of your system’s health without requiring any manual commands. On macOS the output is piped through lolcat for colorized rendering; on Windows the line is printed in plain cyan.

​
What’s Displayed

Aurora collects four live metrics plus a version string and assembles them into a single, centered stats line each time the dashboard renders.

​
CPU Usage

Aurora reads current CPU utilization from the OS directly at display time.
  • macOS (Zsh): top -l 1 | grep 'CPU usage' | awk '{print $3}'
  • Windows (PowerShell): (Get-Counter '\Processor(_Total)\% Processor Time').CounterSamples.CookedValue

​
Free Disk

Reports the available space on the root volume (/ on macOS, C: on Windows).
  • macOS (Zsh): df -h / | awk 'NR==2 {print $4}'
  • Windows (PowerShell): (Get-PSDrive C).Free / 1GB

​
Battery

Reports the current battery charge percentage.
  • macOS (Zsh): pmset -g batt | grep -Eo '[0-9]+%' | head -1
  • Windows: Battery is not shown. AC power is assumed; the field is omitted from the stats line.

​
Date

Shows the current date in MM/DD/YY format.
  • macOS (Zsh): date +'%D'
  • Windows (PowerShell): Get-Date -Format "MM/dd/yy"

​
Version

The AURORA_VER value is read from ~/.aurora-shell_files/aurora-shell_settings and displayed as AURORA v<version> at the start of the stats line.
The assembled stats line looks like this, centered to your terminal width: 
⚡ AURORA v5.6.2 | 🧠 CPU: 12.5% | 💾 FREE: 45Gi | 🔋 87% | 📅 01/15/25

​
The Separator Line

Directly below the stats line, Aurora draws a full-width horizontal rule made of dash (-) characters. On macOS the line is rendered through safe_lolcat() (which falls back to plain cat if lolcat is not installed). On Windows it is printed in cyan. The line is drawn to exactly the current terminal width using tput cols (macOS) or $Host.UI.RawUI.WindowSize.Width (Windows), so it always spans edge-to-edge regardless of window size.

​
Manually Refreshing

To redraw the diagnostics banner and pick up fresh metrics without restarting your terminal, run: 
shell.aurora --display
This calls Show-Aurora() directly and re-runs all the telemetry commands, printing an updated stats line and separator.

​
System Info Flag

For deeper hardware and OS information, Aurora exposes a dedicated flag: 
shell.aurora --sys
  • macOS: Runs sw_vers && sysctl -n machdep.cpu.brand_string — prints the macOS product name, version, build, and the full CPU model string.
  • Windows: Runs Get-ComputerInfo | Select-Object CsName, WindowsVersion, OsArchitecture — prints the computer name, Windows version string, and architecture.
If you’re on macOS without lolcat installed, all colorized output falls back to plain cat via the safe_lolcat() helper that is bundled in the theme file. You can install lolcat at any time with brew install lolcat to restore the rainbow output.

Build docs developers (and LLMs) love

Get started for freeTalk to us