-
Notifications
You must be signed in to change notification settings - Fork 42
CLI Reference
GitHub Actions edited this page Apr 9, 2026
·
3 revisions
The aidevops command provides a unified interface for managing your AI DevOps installation.
The CLI is installed automatically by setup.sh:
bash <(curl -fsSL https://raw.githubusercontent.com/marcusquinn/aidevops/main/setup.sh)
```text
**Location:** `/usr/local/bin/aidevops` (or `~/.local/bin/aidevops` if no sudo)
## Commands
| Command | Alias | Description |
|---------|-------|-------------|
| `aidevops status` | | Check installation status of all components |
| `aidevops update` | `upgrade` | Update to the latest version |
| `aidevops uninstall` | | Remove aidevops from your system |
| `aidevops version` | `-v`, `--version` | Show version information |
| `aidevops help` | `-h`, `--help` | Show help message |
## Command Details
### `aidevops status`
Displays comprehensive status of your installation:
```bash
aidevops status
```text
**Checks performed:**
| Category | Items Checked |
|----------|---------------|
| **Version** | Current vs latest, update notification |
| **Installation Paths** | Repository location, agents directory |
| **Required Dependencies** | git, curl, jq, ssh |
| **Optional Dependencies** | sshpass |
| **Recommended Tools** | Tabby terminal, Zed editor + OpenCode extension |
| **Git CLI Tools** | gh (GitHub), glab (GitLab), tea (Gitea) |
| **AI Tools & MCPs** | OpenCode CLI, Augment Context Engine, osgrep |
| **Development Environments** | DSPy, DSPyGround |
| **AI Assistant Configs** | OpenCode, Cursor, Claude, Continue.dev, Windsurf, Gemini, Warp, Codex, Kiro |
| **SSH Configuration** | Ed25519 key presence |
**Example output:**
```text
AI DevOps Framework Status
==========================
Version: 2.12.0
Latest: 2.12.0 (up to date)
Installation:
Repository: ~/Git/aidevops
Agents: ~/.aidevops/agents/
Required Dependencies:
[OK] git
[OK] curl
[OK] jq
[OK] ssh
Recommended Tools:
[OK] Tabby
[OK] Zed
[OK] OpenCode extension
AI Assistants:
[OK] OpenCode (~/.config/opencode/AGENTS.md)
[OK] Cursor (.cursorrules)
...
```text
### `aidevops update`
Updates to the latest version:
```bash
aidevops update
# or
aidevops upgrade
```text
**What it does:**
1. Pulls latest changes from the repository
2. Re-runs setup.sh to update configurations
3. Updates the CLI command itself
### `aidevops uninstall`
Removes aidevops from your system:
```bash
aidevops uninstall
```text
**What gets removed:**
| Item | Path |
|------|------|
| Agents directory | `~/.aidevops/` |
| AI assistant references | Various config files |
| Shell aliases | `.bashrc`, `.zshrc`, etc. |
| AI memory files | `CLAUDE.md`, `GEMINI.md`, `WINDSURF.md`, etc. |
| CLI command | `/usr/local/bin/aidevops` |
| Repository | `~/Git/aidevops` (asks separately) |
**What is NOT removed:**
- Installed tools (Tabby, Zed, gh, glab)
- SSH keys
- Python/Node environments
- API keys in `~/.config/aidevops/`
### `aidevops version`
Shows version information:
```bash
aidevops version
# or
aidevops -v
aidevops --version
```text
### `aidevops help`
Shows help message:
```bash
aidevops help
# or
aidevops -h
aidevops --help
```text
## Shell Integration
Setup detects your shell and configures aliases appropriately:
| Shell | Config File |
|-------|-------------|
| bash | `~/.bashrc` or `~/.bash_profile` |
| zsh | `~/.zshrc` |
| fish | `~/.config/fish/config.fish` |
| ksh | `~/.kshrc` |
## Package Manager Support
Setup auto-detects and uses your system's package manager:
| Manager | Systems |
|---------|---------|
| brew | macOS, Linux (Homebrew) |
| apt | Debian, Ubuntu |
| dnf | Fedora, RHEL 8+ |
| yum | CentOS, RHEL 7 |
| pacman | Arch Linux |
| apk | Alpine Linux |
## Examples
### Fresh Install
```bash
# Install everything
bash <(curl -fsSL https://raw.githubusercontent.com/marcusquinn/aidevops/main/setup.sh)
# Check what was installed
aidevops status
```text
### Update Existing Installation
```bash
# Quick update
aidevops update
# Or re-run the one-liner (same effect)
bash <(curl -fsSL https://raw.githubusercontent.com/marcusquinn/aidevops/main/setup.sh)
```text
### Check if Update Available
```bash
aidevops status
# Look for "Update available" message
```text
### Clean Uninstall
```bash
aidevops uninstall
# Follow prompts to remove components
```text
## Troubleshooting
### Command Not Found
If `aidevops` command is not found after installation:
```bash
# Check if it's in PATH
which aidevops
# If using ~/.local/bin, ensure it's in PATH
export PATH="$HOME/.local/bin:$PATH"
# Or run directly
~/.local/bin/aidevops status
```text
### Permission Denied
If you get permission errors:
```bash
# The installer will fall back to ~/.local/bin automatically
# Or manually move:
sudo mv ~/.local/bin/aidevops /usr/local/bin/
```text
### Update Fails
If update fails, try a fresh install:
```bash
# Remove and reinstall
aidevops uninstall
bash <(curl -fsSL https://raw.githubusercontent.com/marcusquinn/aidevops/main/setup.sh)
```text