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.

Aurora Shell ships with a built-in package manager exposed through the shell command. It maintains a local JSON registry at ~/.aurora-shell_files/packages.json and lets you install, search, list, add, and remove packages directly from the terminal. When a requested package is not in the Aurora registry, shell install automatically falls back to Homebrew on macOS or winget on Windows, so you rarely need to switch tools.

Installing a Package

shell install <package-name>
Aurora first looks up <package-name> (or any of its aliases) in ~/.aurora-shell_files/packages.json. If a match is found, it is installed according to its type:
TypeBehavior
dmgDownloads the .dmg, mounts it, copies the .app to ~/Applications, and unmounts
binaryDownloads the binary to ~/.aurora-shell_files/bin/ and marks it executable
brewDelegates to brew install <formula>
cli-installerWrites the CLI script to ~/.aurora-shell_files/bin/CLI and marks it executable
If the package is not found in the Aurora registry, shell falls back automatically:
  • macOS: searches Homebrew (brew info <name>) and offers to run brew install
  • Windows: searches winget (winget search <name>) and offers to run winget install

Built-In Package Registry

Aurora ships with two packages pre-registered out of the box:
Package IDAliasesTypeDescription
Aurora.Appaurora-appdmgAurora Shell Terminal App (.dmg)
Aurora.CLICLIcli-installerAurora Shell CLI installer
Install them with:
# Install the Aurora Shell desktop app
shell install Aurora.App

# Install the CLI command (unlocks 38+ developer tools)
shell install CLI

Searching Packages

shell search [query]
Without a query, shell search prints all packages currently in the Aurora registry in a formatted table showing Name, ID, Version, and Source. If you supply a query string, it also passes it to Homebrew (macOS) or winget (Windows) and appends those results below the Aurora registry output.

Listing Installed Packages

shell list
Lists every binary currently present in ~/.aurora-shell_files/bin/. These are packages that have been installed via shell install with a binary or cli-installer type.

Adding a Package to the Registry

shell add <name> <url> <type> <description>
This command adds a new entry to your local packages.json immediately, then opens a pre-filled GitHub issue in your browser to request community approval for inclusion in the official registry. Valid types are binary, brew, and dmg. Example:
shell add my-tool https://example.com/my-tool.tar.gz binary "My custom CLI tool"
You will be prompted to confirm before anything is written or submitted.

Removing a Package

shell remove <package-name>
Removes the entry from your local packages.json and opens a pre-filled GitHub issue requesting that the package be removed from the official registry as well. You will be prompted to confirm before the local removal and issue submission proceed.

Uninstalling a Package

shell uninstall <package-name>
Deletes the package binary from ~/.aurora-shell_files/bin/. For .app bundles installed from a dmg, it also removes the app from ~/Applications and /Applications.

Package Storage

All binaries installed by shell are placed in:
~/.aurora-shell_files/bin/
This directory is automatically added to $PATH during Aurora Shell setup, so any binary installed there is immediately available as a command in new terminal sessions.
Run shell install CLI first to unlock the full catalog of 38+ developer CLI tools. Once the CLI command is installed, use CLI list to browse every available package, and CLI install <package> to install any of them — for example CLI install GitHub.CLI, CLI install Docker.CLI, or CLI install HashiCorp.Terraform.

Build docs developers (and LLMs) love