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 accounts are entirely optional, but they unlock cross-machine profile synchronisation. When you sign in, Aurora fetches your stored header style, installed packages, and linked service credentials from the Aurora Accounts worker hosted at https://aurora-accounts.yash-behera.workers.dev and applies them to the local environment automatically. You can create and manage your account from inside the setup wizard during installation, or at any time afterwards using the shell.aurora --account subcommands described on this page.

​
Creating an Account

During the macOS setup wizard the installer prompts: 
🌐 Aurora Account (optional — syncs your profile across machines)
   Sign in? (y/n/create):
Entering create starts the account creation flow. You can also create an account at any time after installation with: 
shell.aurora --account --create
The flow prompts for a username and a password (entered twice for confirmation). The password is never transmitted in plain text — it is hashed locally with SHA-256 before being sent: 
_hash=$(echo -n "$_pw" | shasum -a 256 | awk '{print $1}')
The hashed payload is then POST’d to the accounts API: 
POST https://aurora-accounts.yash-behera.workers.dev/accounts
On success you will see: 
✅ Account created. You can now login with: aurora --account --login

​
Signing In

shell.aurora --account --login
Aurora prompts for your username and password, hashes the password with SHA-256, and POST’s the credentials to: 
POST https://aurora-accounts.yash-behera.workers.dev/accounts/login
On a successful response Aurora:
  1. Writes the full account JSON (including your profile settings) to ~/.aurora-shell_files/active_account.json.
  2. Updates AURORA_ID in the settings file to match your account username, so your prompt reflects your account identity.
  3. Applies your stored header mode and header value to the settings file.
  4. Installs any Zsh plugins listed in your account profile (e.g. zsh-autosuggestions, zsh-syntax-highlighting) if they are not already present.
To skip plugin installation and apply only the configuration changes, use the --fast flag: 
shell.aurora --account --login --fast

​
Account Commands

All account management goes through shell.aurora --account followed by one of the subflags below.
SubflagDescription
--createCreate a new Aurora account. Prompts for username and a confirmed password.
--loginSign in to an existing account. Fetches your profile and applies it locally.
--logoutClear the local session. Removes active_account.json, restores shell config files to their pre-login state, and uninstalls packages that were added during the session.
--linkLink a third-party service to your account (AWS, GitHub, OpenAI, Anthropic, or Ollama). Credentials are stored in your account profile and exported as environment variables on next login.
--whoamiPrint the username of the currently signed-in account, along with active plugins and linked services.
--usersList all registered Aurora accounts. This is an owner-only admin feature and requires your password for authentication.

​
Usage examples

shell.aurora --account --create    # create a new account
shell.aurora --account --login     # sign in
shell.aurora --account --logout    # sign out and restore system state
shell.aurora --account --link      # link a service (AWS, GitHub, OpenAI, …)
shell.aurora --account --whoami    # show who is signed in
shell.aurora --account --users     # list all users (owner only)

​
What Gets Synced

When you sign in, Aurora reads the following fields from your account profile and applies them locally:
  • Username — written to AURORA_ID so the prompt matches your account identity across all machines.
  • Header style and value — AURORA_HDR_MODE and AURORA_HDR_VAL are updated in the settings file to match the header stored in your account.
  • Installed packages — the list of Zsh plugins stored in your account (plugins array) is installed into the oh-my-zsh custom plugins directory if not already present.
  • Linked service credentials — the linked object in your account profile stores third-party service credentials (AWS keys, GitHub tokens, OpenAI and Anthropic API keys, Ollama host). These are exported as environment variables (AWS_ACCESS_KEY_ID, GITHUB_TOKEN, OPENAI_API_KEY, etc.) automatically on sign-in.

​
Account File Location

The active session is stored as JSON at: 
~/.aurora-shell_files/active_account.json
This file is created on sign-in and deleted on sign-out (--logout). It contains your full account profile including cached settings. Do not commit this file to version control.
Accounts are optional — Aurora Shell works fully offline without an account. All header, prompt, and PIN settings are stored locally in ~/.aurora-shell_files/aurora-shell_settings and do not require a network connection.

Build docs developers (and LLMs) love

Get started for freeTalk to us