Professional-grade global help indexer with BLUX integration
Project description
GOD — Global Operations Deity
🚀 Professional-grade global help indexer with BLUX integration
🚀 Quick Install
One-line installers:
# Using curl
curl -sSL https://raw.githubusercontent.com/Outer-Void/god/main/install_deps.sh | bash
# Using wget
wget -q -O - https://raw.githubusercontent.com/Outer-Void/god/main/install_deps.sh | bash
Traditional methods:
# From PyPI
pip install god-cli
# From source
git clone https://github.com/Outer-Void/god.git
cd god
./install_deps.sh
source activate_god.sh
🎯 Quick Start
# Console summary
god build -f console --limit 20
# Save documentation
god build -o docs/help.md # Markdown
god build -f html -o docs/help.html # HTML
god build -f json -o docs/help.json # JSON
# Search & Info
god search docker
god stats
god info python
✨ Features
- Security: Risk assessment = (LOW/MEDIUM/HIGH/CRITICAL)
- Performance: Parallel processing with ThreadPoolExecutor
- Multi-format: Markdown, JSON, HTML, Console output
- Cross-platform: Windows, macOS, Linux
- BLUX Integration: Soft routes for ecosystem tools
🔧 Usage
Build Documentation
# Quick console view
god build -f console --limit 50
# Generate reports
god build -f md -o docs/commands.md
god build -f html -o security-audit.html
god build -f json -o catalog.json
Search Commands
# Search help text
god search docker
# Search names only (faster)
god search --names-only ssh
Statistics & Info
# View statistics with risk breakdown
god stats
# Get detailed command info
god info python
Parallel Processing
# Use more workers for faster processing
god build --max-workers 16 --limit 100
# Balance performance
god search "network" --max-workers 8
BLUX Integration
god blux q --help
god blux dat --version
god blux lrc --help
god blux scan --help
🛠 Development
# Install with dev dependencies
./install_deps.sh --dev
# Or using pip
pip install -e ".[dev]"
# Run tests
make test
# Lint code
make lint
# Format code
make format
# Clean artifacts
make clean
# Build package
make build
📦 Installation Details
System Requirements
· Python 3.8+ · pip (latest version recommended)
Virtual Environment (Recommended)
python -m venv god_env
source god_env/bin/activate # Linux/macOS
# OR
god_env\Scripts\activate # Windows
pip install god-cli
Troubleshooting
# If installation fails, try:
pip install --upgrade pip
pip install god-cli
# Permission issues on Linux/macOS:
pip install --user god-cli
# Or use sudo (not recommended):
sudo pip install god-cli
🔗 Dependencies
· typer>=0.20.0 - CLI framework
· rich>=13.8.0 - Beautiful terminal output
· click>=8.1.7 - Command line interface
📄 License
MIT License - See LICENSE
📞 Support
📋 Changelog
See CHANGELOG.md for version history and updates.
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
god_cli-1.0.1.tar.gz
(16.6 kB
view details)
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
god_cli-1.0.1-py3-none-any.whl
(13.5 kB
view details)
File details
Details for the file god_cli-1.0.1.tar.gz.
File metadata
- Download URL: god_cli-1.0.1.tar.gz
- Upload date:
- Size: 16.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4719fe8222c595045d4fea6d603c56e72c24eb0ce792a23248a3cfdb2692abf
|
|
| MD5 |
34484d9fec17f7ab1b8df4d674ee3c77
|
|
| BLAKE2b-256 |
6ae9c522e32a9a20ea45bb8c8e8264acb5ac09c2a997a5a267bbcdab2663d9b1
|
File details
Details for the file god_cli-1.0.1-py3-none-any.whl.
File metadata
- Download URL: god_cli-1.0.1-py3-none-any.whl
- Upload date:
- Size: 13.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc22cf974051d79da2a3ab677feb8f4a2849b90f90c53bd41be682eae527ea15
|
|
| MD5 |
22937a4f19477e62a8822c3a3838357b
|
|
| BLAKE2b-256 |
d2de55df94d985b631680270d28e25127c2d81d1372a2d9a9ff7870925aa7315
|