Quick Start Guide

Get up and running with a12z in minutes

Step 1: Installation

Install with Homebrew

Add the tap
brew tap muhammadarslan/a12z
Install a12z
brew install a12z

💡 Tip: Verify installation with a12z --help

Step 2: Your First Commands

Start the Interactive Shell

Simply type a12z to start:

$ a12z
Welcome to a12z! Type 'help' for available commands.
$ _

Create Your First Alias

Create shortcuts for commands you use frequently:

$ a12z alias add gs 'git status'
✓ Alias 'gs' added.

Now you can use gs instead of typing git status!

Run a Single Command

Execute commands without entering the interactive shell:

$ a12z run 'ls -la'
$ a12z run 'git status'

Step 3: Useful Aliases to Get Started

Here are some popular aliases that developers find useful:

Git Shortcuts

a12z alias add gs 'git status'
a12z alias add gco 'git checkout'
a12z alias add gcm 'git commit -m'

Navigation

a12z alias add dev 'cd ~/projects && npm run dev'
a12z alias add work 'cd ~/work'

Docker

a12z alias add dps 'docker ps'
a12z alias add dex 'docker exec -it'

System

a12z alias add ports 'lsof -i -P -n | grep LISTEN'
a12z alias add reload 'source ~/.zshrc'

Step 4: Productivity Tips

Use Command History

Press ↑ to cycle through previous commands. a12z learns from your history to provide better autocomplete suggestions.

Leverage the Enhanced Prompt

The prompt shows git status, kubernetes context, and command timing. No need to run git status constantly!

Chain Commands

Use && and || for conditional execution:

git pull && npm install && npm run build

Background Jobs

Run long-running commands in the background with &:

npm start &

Next Steps