Skip to main content

AI Society Godfather CLI - RunPod Environment Manager

Project description

Godfather CLI

Beautiful command-line interface for managing AI Society ASU RunPod environments.

CLI Demo License

โœจ Features

  • ๐ŸŽจ Beautiful Interface - Rich terminal UI with colors, tables, and panels
  • ๐Ÿ” Secure Authentication - Discord-based authentication
  • ๐Ÿš€ Pod Management - List and connect to available RunPod environments
  • ๐Ÿ”Œ SSH Integration - Automatic SSH key setup and connection
  • ๐Ÿ“Š Status Monitoring - Check authentication and configuration status

๐Ÿ“ฆ Installation

Option 1: Install from PyPI (Recommended)

pip install godfather-cli

Option 2: Install from GitHub

pip install git+https://github.com/theaisocietyasu/godfather.git#subdirectory=cli

Option 3: Install for Development

git clone https://github.com/theaisocietyasu/godfather.git
cd godfather/cli
pip install -e .

๐Ÿš€ Quick Start

  1. Run the CLI:

    godfather
    
  2. Authenticate:

    • Visit the admin portal to get your authentication token
    • Paste the token when prompted
  3. Connect to a Pod:

    • Select option 2 to connect to a pod
    • Choose from available pods
    • Automatically SSH into your isolated workspace

๐Ÿ“– Usage

Interactive Menu

Simply run:

godfather

You'll see a beautiful menu:

โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
โ•‘ Godfather CLI                         โ•‘
โ•‘ AI Society RunPod Environment Manager โ•‘
โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ What would you like to do? โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ 1.  ๐Ÿ“‹ List available pods                   โ”‚
โ”‚ 2.  ๐Ÿ”Œ Connect to a pod                      โ”‚
โ”‚ 3.  ๐Ÿ“Š Show status                           โ”‚
โ”‚ 4.  ๐Ÿšช Logout                                โ”‚
โ”‚ 5.  ๐Ÿ‘‹ Exit                                  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Command-Line Interface

# List available pods
godfather list

# Connect to a specific pod
godfather connect <pod-id>

# Connect interactively
godfather connect

# Show CLI status
godfather status

# Logout
godfather logout

# Re-authenticate
godfather auth

# Use custom API URL
godfather --api-url https://your-api.com list

๐Ÿ”‘ Authentication

  1. Get your authentication token from: https://your-godfather-instance.com/cli-auth
  2. Run godfather or godfather auth
  3. Paste your token when prompted
  4. Token is securely stored in ~/.godfather/config.json

๐Ÿ› ๏ธ Configuration

Configuration is stored in ~/.godfather/config.json:

{
  "token": "discord_<user_id>_<timestamp>",
  "discord_user_id": "<your_discord_id>"
}

๐ŸŽจ Features in Detail

Beautiful Tables

Pod listings display in rich, colorful tables:

           ๐Ÿš€ Available Pods (3)
โ•ญโ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ # โ”‚ Status โ”‚ Name        โ”‚ ID           โ”‚ Created   โ”‚
โ”œโ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 1 โ”‚ ๐ŸŸข RUN โ”‚ ml-training โ”‚ abc123def... โ”‚ 2 days agoโ”‚
โ”‚ 2 โ”‚ ๐ŸŸข RUN โ”‚ gpu-dev     โ”‚ xyz789ghi... โ”‚ 1 week agoโ”‚
โ”‚ 3 โ”‚ ๐Ÿ”ด OFF โ”‚ testing     โ”‚ jkl456mno... โ”‚ 3 days agoโ”‚
โ•ฐโ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Status Dashboard

        Godfather CLI Status
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ ๐Ÿ” Authentication   โ”‚ โœ“ Authenticated             โ”‚
โ”‚ ๐ŸŒ API Connection   โ”‚ โœ“ Connected                 โ”‚
โ”‚ ๐Ÿ  Config Directory โ”‚ /home/user/.godfather       โ”‚
โ”‚ ๐Ÿ”— API Endpoint     โ”‚ https://api.example.com     โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ†˜ Support

๐ŸŽ“ About

Built with โค๏ธ by AI Society at Arizona State University

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godfather_cli-1.0.4.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godfather_cli-1.0.4-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file godfather_cli-1.0.4.tar.gz.

File metadata

  • Download URL: godfather_cli-1.0.4.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for godfather_cli-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7af53b6f0f2cfe48a19be287def116f8256db4766fccde0cc55d63dc8bc62689
MD5 2e5f766d2174034a239dfada429a3de9
BLAKE2b-256 43e5ed69a17b1b857f875bcb190a5613260d7463b80cc25a1db8d2d81c07850b

See more details on using hashes here.

Provenance

The following attestation bundles were made for godfather_cli-1.0.4.tar.gz:

Publisher: publish-cli.yml on theaisocietyasu/godfather

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file godfather_cli-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: godfather_cli-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for godfather_cli-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 44378f91817cb5242f4fd86fcdafed85997028b1c90bf3d6a51996d782aea308
MD5 6e8a88a042185539e8ea82dc2dbcb0af
BLAKE2b-256 62a30f5edf7ec0de4feeddd3f7885e19b35afca2a13a98025d5a1968ce491aea

See more details on using hashes here.

Provenance

The following attestation bundles were made for godfather_cli-1.0.4-py3-none-any.whl:

Publisher: publish-cli.yml on theaisocietyasu/godfather

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page