Skip to content

QUICKSTART.md

Latest commit

 

History

History
110 lines (85 loc) · 2.44 KB

QUICKSTART.md

File metadata and controls

110 lines (85 loc) · 2.44 KB
Raw

Guardian Quick Start Guide

Installation (Windows)

  1. Navigate to project directory:

    cd c:\Users\MyBook Hype AMD\workarea\guardian-cli

  2. Create virtual environment:

    python -m venv venv
.\venv\Scripts\activate

  3. Install Guardian:

    pip install -e .

  4. Initialize configuration:

    python -m cli.main init

    Or use the batch launcher:

    

    5. 

  5. 

    Configure Authentication:
    

    Option A: Antigravity Auth (Free/Quota)
    

    python -m cli.main auth login
    

    Option B: Standard API Key
Create a .env file with your key:
    

    echo GOOGLE_API_KEY=your_key_here > .env
    

    6. 



Common Commands


List Available Workflows


python -m cli.main workflow list


Dry Run Reconnaissance


python -m cli.main recon --domain example.com --dry-run


Run Port Scan (requires nmap)


python -m cli.main scan --target scanme.nmap.org


Run Full Workflow


python -m cli.main workflow run --name recon --target example.com


Run with Specific AI Model


python -m cli.main recon --domain example.com --model gemini-3-pro


Configuration


Edit config/guardian.yaml or ~/.guardian/guardian.yaml to customize:


    

  • AI model and settings
    • 

  • Tool configurations
    • 

  • Security guardrails
    • 

  • Output formats
    • 



Getting Help


python -m cli.main --help
python -m cli.main <command> --help


Important Notes


    

  • Windows: Use python -m cli.main or .\guardian.bat instead of guardian
    • 

  • API Key: Required for AI features (get from https://makersuite.google.com/app/apikey)
    • 

  • External Tools: Optional but recommended (nmap, httpx, subfinder, nuclei)
    • 

  • Authorization: Only scan systems you have explicit permission to test
    • 



Troubleshooting


Command not found


    

  • Make sure you're in the project directory
    • 

  • Activate the virtual environment
    • 

  • Use python -m cli.main instead of guardian
    • 



Import errors


    

  • Reinstall dependencies: pip install -e .
    • 

  • Check Python version: python --version (requires 3.11+)
    • 



API errors


    

  • Verify your Gemini API key in .env or .guardian/.env
    • 

  • Check internet connectivity
    • 



Next Steps


    

  1. Install external pentest tools for full functionality
    2. 

  2. Review config/guardian.yaml and customize settings
    3. 

  3. Run --dry-run mode to see what would be executed
    4. 

  4. Start with safe targets like scanme.nmap.org
    5. 

  5. Review logs in logs/guardian.log
    6.