Getting Started with Aion
Installation
Section titled “Installation”Homebrew (macOS/Linux)
Section titled “Homebrew (macOS/Linux)”brew tap nick-skriabin/tapbrew install aionDownload Binary
Section titled “Download Binary”Grab the latest release for your platform from the Releases page:
| Platform | Binary |
|---|---|
| macOS (Apple Silicon) | aion-darwin-arm64 |
| macOS (Intel) | aion-darwin-x64 |
| Linux (x64) | aion-linux-x64 |
| Linux (ARM64) | aion-linux-arm64 |
# Make executablechmod +x aion-darwin-arm64
# Move to PATHsudo mv aion-darwin-arm64 /usr/local/bin/aion
# RunaionBuild from Source
Section titled “Build from Source”git clone https://github.com/semos-labs/aion.gitcd aionbun install
# Run in developmentbun dev
# Build binary for current platformbun run build# Binary will be at ./dist/aionConnect a Calendar
Section titled “Connect a Calendar”Aion supports Google Calendar and CalDAV (iCloud, Fastmail, Nextcloud, Radicale, etc.). You can use both at the same time with multiple accounts.
Option A: CalDAV (iCloud, Fastmail, Nextcloud, etc.)
Section titled “Option A: CalDAV (iCloud, Fastmail, Nextcloud, etc.)”Add your CalDAV account to ~/.config/aion/config.toml:
[[caldav]]name = "iCloud"email = "me@icloud.com"serverUrl = "https://caldav.icloud.com"username = "me@icloud.com"passwordCommand = "security find-generic-password -a me@icloud.com -s aion-caldav -w"Or use the interactive dialog:
:caldavProvider URLs
Section titled “Provider URLs”| Provider | Server URL |
|---|---|
| iCloud | https://caldav.icloud.com |
| Fastmail | https://caldav.fastmail.com/dav/calendars |
| Nextcloud | https://your-server.com/remote.php/dav |
| Radicale | https://your-server.com/radicale |
| Google (via CalDAV) | https://apidata.googleusercontent.com/caldav/v2 |
Tip: For iCloud, use an app-specific password — not your Apple ID password.
Password commands
Section titled “Password commands”passwordCommand runs via sh -c and uses the trimmed stdout as the password:
| Method | Example |
|---|---|
| macOS Keychain | passwordCommand = "security find-generic-password -a me@icloud.com -s aion-caldav -w" |
pass (GPG) | passwordCommand = "pass show calendar/icloud" |
| 1Password CLI | passwordCommand = "op read op://Personal/iCloud/password" |
| Bitwarden CLI | passwordCommand = "bw get password icloud-caldav" |
| Environment var | passwordCommand = "echo $CALDAV_PASSWORD" |
Option B: Google Calendar (OAuth)
Section titled “Option B: Google Calendar (OAuth)”Set Up Google Cloud Credentials
Section titled “Set Up Google Cloud Credentials”Aion requires your own Google Cloud credentials to access Google Calendar.
- Go to Google Cloud Console
- Create a new project (or select an existing one)
- Enable the Google Calendar API:
- Go to “APIs & Services” → “Library”
- Search for “Google Calendar API”
- Click “Enable”
Create OAuth Credentials
Section titled “Create OAuth Credentials”- Go to “APIs & Services” → “Credentials”
- Click “Create Credentials” → “OAuth client ID”
- If prompted, configure the OAuth consent screen:
- User Type: External (or Internal for Workspace)
- Add your email as a test user
- Add the following scopes:
https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profile
- Create OAuth client ID:
- Application type: Desktop app
- Name: “Aion” (or anything you like)
- Copy the Client ID and Client Secret
Configure Aion
Section titled “Configure Aion”Add your credentials to ~/.config/aion/config.toml:
[google]clientId = "your-client-id.apps.googleusercontent.com"clientSecret = "your-client-secret"Or use environment variables:
export AION_GOOGLE_CLIENT_ID="your-client-id.apps.googleusercontent.com"export AION_GOOGLE_CLIENT_SECRET="your-client-secret"Connect Google Calendar
Section titled “Connect Google Calendar”Launch Aion and run the login command:
:loginFollow the OAuth flow in your browser. Aion supports multiple Google accounts.
Basic Navigation
Section titled “Basic Navigation”| Key | Action |
|---|---|
j / k | Move down / up |
h / l | Previous / next day |
Tab / ` | Cycle focus between panes |
gg / G | Jump to first / last item |
n | Jump to now |
Ctrl+G | Go to date (natural language) |
Enter / Space | Open event details |
Ctrl+N | Create new event |
e | Edit event |
D | Delete event |
/ | Search events |
: | Open command palette |
? | Show context-aware help |
q | Quit |
Next Steps
Section titled “Next Steps”- See the full keybindings and commands reference for everything Aion can do
- Customize your theme via
~/.config/aion/config.toml