arjunsenngupta1008/hyejack-powershell repository overview

This project is open source.
GitHub Repository: https://github.com/PersonalProj1008/HyeJack-Powershell⁠

⁠HyeJack-Powershell

⁠AI-Powered Agentic PowerShell Automation with Self-Healing

⁠What is HyeJack-Powershell?

HyeJack-Powershell is a containerized AI automation engine that transforms natural language requests into executable PowerShell workflows using xAI's Grok LLM. It features automatic error correction, persistent knowledge bases (RAG), and multi-tool integration.

Turn this: "Create a script that backs up my project folder and uploads to S3"

Into working PowerShell code automatically.

⁠Key Features

⁠Quick Start

⁠Prerequisites

• Docker & Docker Compose
• xAI API key (Grok LLM)
• Grok Management API key (for file operations)

⁠1. Pull & Run

docker compose up -d
docker compose exec pwsh-worker pwsh

⁠2. Configure Credentials (First Run Only)

Inside the container:

HyeJack-Powershell --CREDENTIALS

⁠3. Create a Topic & Start Using

HyeJack-Powershell --SIDEBAR
HyeJack-Powershell --HYE_JACK "Create a PowerShell script that lists all PDF files in current directory" --AVGCHATHISTORY

⁠API Key Requirements

⁠Grok LLM API Key

• Standard xAI API key for Grok model access
• Used for generating workflows and responses

⁠Grok Management API Key

Required permissions:

⁠File Permissions

⁠Collections Endpoint Group

⚠️ Must be enabled (Custom or Full access) for collection operations:

• Create collection
• List collections
• Update collection (name, description)
• Delete collection
• Manage documents inside collections

⁠Supported File Types (RAG Knowledge Base)

Documents: .pdf, .doc, .docx, .txt, .md, .csv, .json, .xml, .yaml, .html, .htm, .rtf

Code: .py, .js, .ts, .tsx, .jsx, .cs, .go, .java, .kt, .rs, .swift, .php, .rb, .pl, .lua, .sql, .ps1, .sh

Not supported: Standalone images (.jpg, .png, .gif) — but images inside PDFs work.

⁠Customizing Jack's Behavior

Edit hyejack_powershell_configuration.toml to modify system prompts:

SYSTEM_PROMPT = '''
You are an AI assistant named Jack...
[Modify personality, tone, or specialization here]
'''

GROK_MODEL_NAME = "grok-4-1-fast-reasoning"  # Change model as needed

⚠️ Important: Keep the JSON output structure unchanged — the Python backend expects specific keys:

• Agentic_Data → for workflows
• Info_Data → for informational responses
• step, use_env, steps_to_not_include within workflows

⁠Tool Flags

⁠Chat History

⁠Example Workflows

# Code generation
HyeJack-Powershell --HYE_JACK "Create a FastAPI endpoint with PostgreSQL connection" --AVGCHATHISTORY

# File analysis + research
HyeJack-Powershell --HYE_JACK "Review my Python project and suggest improvements based on best practices" --FULLPOWER --COLLECTIONREF

# Automation script
HyeJack-Powershell --HYE_JACK "Build a script that monitors disk space and emails alerts at 90% usage"

⁠How Self-Healing Works

1. Generated PowerShell script executes
2. On failure → error + context sent back to Grok
3. Grok fixes only the failing step
4. Workflow re-executes
5. Repeats up to --TRYCOUNT (default: 20)

⁠Environment Variables

⁠Volumes