Skip to content
/
CLI Installation
Last updated

Aitronos CLI Installation Guide

The Aitronos CLI is a command-line tool for managing Streamline automations, authentication, and deployments.

Installation

pip install aitronos-cli

Using pipx (Isolated Environment)

# Install pipx if not already installed
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install aitronos-cli
pipx install aitronos-cli

From Source

git clone https://github.com/Aitronos-Development/aitronos.cli.git
cd aitronos.cli
pip install -e .

Verify Installation

# Check version
aitronos --version

# View help
aitronos --help

Quick Start

1. Authenticate

aitronos auth login

This opens your browser to log in to Freddy. Once authenticated, your session token is saved locally.

2. Select Organization

# List your organizations
aitronos org list

# Set active organization
aitronos org select <organization-id>

3. Start Using Streamline

# Download project template
aitronos streamline template download

# Deploy automation
aitronos streamline deploy --repo <github-url> --name "My Automation"

# Execute automation
aitronos streamline execute <automation-id>

Available Commands

Authentication

# Login to Freddy
aitronos auth login

# Check current user
aitronos auth whoami

# Logout
aitronos auth logout

Organization Management

# List organizations
aitronos org list

# Select active organization
aitronos org select <org-id>

# Show current organization
aitronos org current

Streamline Automations

# Download templates
aitronos streamline template download [--type project|repository]

# Create GitHub repository
aitronos streamline repo create --name <name> [--private]

# Deploy automation
aitronos streamline deploy --repo <url> --name <name> [--branch main]

# Upload automation (manual)
aitronos streamline upload --file <path> --name <name>

# List automations
aitronos streamline list [--include-inactive]

# Get automation details
aitronos streamline get <automation-id>

# Execute automation
aitronos streamline execute <automation-id> [--param key=value]

# List executions
aitronos streamline executions list <automation-id>

# Get execution details
aitronos streamline executions get <execution-id>

# Sync automation
aitronos streamline sync <automation-id>

# View sync history
aitronos streamline sync-history <automation-id>

# Connect GitHub
aitronos streamline connect <automation-id> --repo <url> --branch <branch>

# Disconnect GitHub
aitronos streamline disconnect <automation-id>

# Set schedule
aitronos streamline schedule set <automation-id> --cron "0 9 * * *"

# Remove schedule
aitronos streamline schedule remove <automation-id>

# Delete automation
aitronos streamline delete <automation-id>

Configuration

Config File Location

The CLI stores configuration in:

  • Linux/Mac: ~/.config/aitronos/config.json
  • Windows: %APPDATA%\aitronos\config.json

Config Structure

{
  "api_url": "https://api.aitronos.com",
  "session_token": "your-session-token",
  "active_organization_id": "org_xyz123",
  "default_branch": "main"
}

Environment Variables

Override config with environment variables:

# API URL
export AITRONOS_API_URL="https://api.aitronos.com"

# Session token
export AITRONOS_SESSION_TOKEN="your-token"

# Organization ID
export AITRONOS_ORG_ID="org_xyz123"

Updating

Update via pip

pip install --upgrade aitronos-cli

Update via pipx

pipx upgrade aitronos-cli

Troubleshooting

Command Not Found

If aitronos command is not found after installation:

Check PATH:

# Add to PATH (Linux/Mac)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Or for zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Reinstall with pipx:

pipx install aitronos-cli
pipx ensurepath

Authentication Failed

If authentication fails:

# Clear cached credentials
rm ~/.config/aitronos/config.json

# Login again
aitronos auth login

SSL Certificate Errors

If you encounter SSL errors:

# Update certificates (Mac)
/Applications/Python\ 3.x/Install\ Certificates.command

# Update certificates (Linux)
sudo apt-get install ca-certificates

# Update certificates (Windows)
pip install --upgrade certifi

Permission Denied

If you get permission errors:

# Install for current user only
pip install --user aitronos-cli

# Or use pipx
pipx install aitronos-cli

Uninstallation

Remove via pip

pip uninstall aitronos-cli

Remove via pipx

pipx uninstall aitronos-cli

Remove config files

# Linux/Mac
rm -rf ~/.config/aitronos

# Windows
rmdir /s %APPDATA%\aitronos

Next Steps

Support

Need help with the CLI?

Previous page
Next page