Skip to content

Outer-Void/god

GOD Logo

GOD β€” Global Operations Deity

πŸš€ Professional-grade global help indexer with BLUX integration

Python 3.8+ License: MIT PyPI Version

πŸš€ 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.

About

Professional-grade global help indexer with BLUX integration

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors