AI Society Godfather CLI - RunPod Environment Manager
Project description
Godfather CLI
Beautiful command-line interface for managing AI Society ASU RunPod environments.
โจ 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
-
Run the CLI:
godfather
-
Authenticate:
- Visit the admin portal to get your authentication token
- Paste the token when prompted
-
Connect to a Pod:
- Select option
2to connect to a pod - Choose from available pods
- Automatically SSH into your isolated workspace
- Select option
๐ 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
- Get your authentication token from:
https://your-godfather-instance.com/cli-auth - Run
godfatherorgodfather auth - Paste your token when prompted
- 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.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file godfather_cli-1.0.7.tar.gz.
File metadata
- Download URL: godfather_cli-1.0.7.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f13be6ab4b5ca6382ba52f829db624341320d627e1c8e55eaa194353e58b03c
|
|
| MD5 |
a74f76af83363908c40ac6bb3c6ffe08
|
|
| BLAKE2b-256 |
2d5ea2e8cbfabcdb74744cfa85678174dc412ed65b0a992b0df6f547e77bc2e3
|
Provenance
The following attestation bundles were made for godfather_cli-1.0.7.tar.gz:
Publisher:
publish-cli.yml on theaisocietyasu/godfather
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godfather_cli-1.0.7.tar.gz -
Subject digest:
8f13be6ab4b5ca6382ba52f829db624341320d627e1c8e55eaa194353e58b03c - Sigstore transparency entry: 850020313
- Sigstore integration time:
-
Permalink:
theaisocietyasu/godfather@b4b9d58a3f8b5ef82231e6153eb06a43e6671b9c -
Branch / Tag:
refs/tags/cli-v1.0.7 - Owner: https://github.com/theaisocietyasu
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-cli.yml@b4b9d58a3f8b5ef82231e6153eb06a43e6671b9c -
Trigger Event:
push
-
Statement type:
File details
Details for the file godfather_cli-1.0.7-py3-none-any.whl.
File metadata
- Download URL: godfather_cli-1.0.7-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bc23e961c390b29e66b7bcac1f4d1ce3b6190ca8836a70b8fa26bbd66d47ab42
|
|
| MD5 |
c72cceeb27645c8b540483217b2969a8
|
|
| BLAKE2b-256 |
d029fa84ee5042eda3327a21482244a07a333656f5ec1588b38d7e67bfbdb573
|
Provenance
The following attestation bundles were made for godfather_cli-1.0.7-py3-none-any.whl:
Publisher:
publish-cli.yml on theaisocietyasu/godfather
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godfather_cli-1.0.7-py3-none-any.whl -
Subject digest:
bc23e961c390b29e66b7bcac1f4d1ce3b6190ca8836a70b8fa26bbd66d47ab42 - Sigstore transparency entry: 850020314
- Sigstore integration time:
-
Permalink:
theaisocietyasu/godfather@b4b9d58a3f8b5ef82231e6153eb06a43e6671b9c -
Branch / Tag:
refs/tags/cli-v1.0.7 - Owner: https://github.com/theaisocietyasu
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-cli.yml@b4b9d58a3f8b5ef82231e6153eb06a43e6671b9c -
Trigger Event:
push
-
Statement type: