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 shell command is Aurora Shell’s built-in package manager. It resolves packages first from the local Aurora registry (~/.aurora-shell_files/packages.json) and falls back to Homebrew (macOS) or winget (Windows) for packages that are not registered. The registry supports four package types — dmg, binary, brew, and cli-installer — and every package can be addressed by either its full ID or any of its declared aliases.
Usage
shell install <package>
Installs a package. Aurora first resolves the name against the local registry (including aliases), then falls back to Homebrew / winget if no match is found.
Syntax
Examples
# Install the Aurora Shell desktop app (dmg)
shell install Aurora.App
# Install the Aurora CLI tool (cli-installer)
shell install CLI
# Use an alias — resolves to Aurora.CLI
shell install CLI
# Fall back to Homebrew for a package not in the Aurora registry
shell install gh
| Type | Behavior |
|---|
dmg | Downloads the .dmg, mounts it with hdiutil, copies the .app bundle to ~/Applications/, then unmounts. |
binary | Downloads the file to ~/.aurora-shell_files/bin/<name> and marks it executable. |
brew | Delegates to brew install <formula>. |
cli-installer | Writes the CLI script to ~/.aurora-shell_files/bin/CLI and marks it executable. |
shell install searches Homebrew (macOS) or winget (Windows) and prompts for confirmation before installing.
shell search [query]
Lists packages available in the Aurora registry. When a query string is provided, it also searches Homebrew (macOS) or winget (Windows) and appends those results.
Syntax
Examples
# List all Aurora registry packages
shell search
# Search Aurora registry and Homebrew/winget for "docker"
shell search docker
Name ID Version Source
------------------------- ------------------------- ---------- ------
Aurora Shell Terminal App Aurora.App latest aurora
Aurora-Shell CLI Aurora.CLI latest aurora
shell list
Lists all files currently installed in ~/.aurora-shell_files/bin/. This reflects every binary or script placed there by shell install (type binary or cli-installer).
Syntax
Example
shell list
# 📦 Installed:
# CLI
shell add <name> <url> <type> <description>
Adds a package to the local Aurora registry and opens a pre-filled GitHub issue for community approval. All four arguments are required.
Syntax
shell add <name> <url> <type> <description>
| Argument | Description |
|---|
<name> | Unique package identifier (e.g., mytool) |
<url> | Direct download URL for the binary or archive |
<type> | One of binary, brew, or dmg |
<description> | Short human-readable description |
shell add mytool https://example.com/mytool.tar.gz binary "My custom tool"
y, the command:
- Adds the package entry to
~/.aurora-shell_files/packages.json.
- Opens a browser tab to a pre-populated GitHub issue at
https://github.com/Seaus-tech/Aurora-Shell/issues/new with the package details filled in for community review.
shell remove <name>
Removes a package from the local Aurora registry and opens a GitHub issue requesting its removal from the upstream registry.
Syntax
Example
Side effects — After confirming with y, the command:
- Deletes the package entry from
~/.aurora-shell_files/packages.json.
- Opens a browser tab to a pre-populated GitHub removal issue.
shell remove only removes the registry entry — it does not delete any installed binary. To remove an installed binary, use shell uninstall.
shell uninstall <name>
Deletes an installed package binary from ~/.aurora-shell_files/bin/ (and removes the corresponding .app bundle from ~/Applications/ or /Applications/ if present).
Syntax
Example
Package Registry File
The local package registry lives at ~/.aurora-shell_files/packages.json. It is created automatically on first install if it does not exist. The default registry ships with two entries:
{
"packages": {
"Aurora.App": {
"aliases": ["aurora-app"],
"url": "https://github.com/Seaus-tech/Aurora-Shell/releases/latest/download/Aurora-Shell.dmg",
"type": "dmg",
"description": "Aurora Shell Terminal App"
},
"Aurora.CLI": {
"aliases": ["CLI"],
"url": "install-cli",
"type": "cli-installer",
"description": "Aurora-Shell CLI - Install CLI versions of apps"
}
}
}
| Field | Type | Description |
|---|
aliases | string[] | Alternative names accepted by shell install |
url | string | Direct download URL, or "install-cli" for the built-in CLI installer |
type | string | dmg, binary, brew, or cli-installer |
description | string | Human-readable description shown in shell search |
shell add or by editing the file directly.