# Getting Started with Ai:oS

Deploy autonomous agents, defensive security tools, and quantum-enhanced algorithms

⚠️ Important: These tools are designed for authorized security assessments only. You MUST have explicit permission before testing any system you don't own. Unauthorized use is illegal and unethical.

1

## Clone the Repository

First, clone the Ai:oS repository which includes the Red Team Tools Suite:

`# Clone via HTTPS git clone https://github.com/Workofarttattoo/AioS.git cd AioS # Or clone via SSH git clone git@github.com:Workofarttattoo/AioS.git cd AioS`

ℹ️ Note on Encrypted Files: Some files are encrypted with git-crypt. You'll see the public interfaces and documentation, but encrypted source code will appear as binary data. This protects proprietary algorithms while keeping usage patterns open.

2

## Install Dependencies

Install the required Python packages:

`# Create a virtual environment (recommended) python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate # Install base dependencies pip install numpy scipy # Optional: Install ML/Quantum dependencies pip install torch # Optional: Install development dependencies pip install pytest black mypy`

✅ Lightweight Setup: The red-team-tools suite has minimal dependencies. Most tools only require NumPy and SciPy!

3

## Verify Installation

Run health checks to ensure everything is working:

`# Check AuroraScan python -m red-team-tools.aurorascan --health --json # Check CipherSpear python -m red-team-tools.cipherspear --health --json # Check MythicKey python -m red-team-tools.mythickey --health --json`

You should see JSON output indicating the health status of each tool.

4

## Run Your First Tool in Demo Mode

Try running a tool in safe demo mode (no actual network activity):

`# Run AuroraScan in demo mode python -m red-team-tools.aurorascan --demo --json # Run CipherSpear in demo mode python -m red-team-tools.cipherspear --demo --json # Run MythicKey in demo mode python -m red-team-tools.mythickey --demo --profile gpu-balanced`

Demo mode simulates tool behavior without making actual connections or tests.

5

## Explore Individual Tools

Once you're comfortable, explore specific tools:

🔍
AuroraScan
💉
CipherSpear
🔑
MythicKey
🗺️
NmapPro
`# Get help for any tool python -m red-team-tools.aurorascan --help # Run with specific options python -m red-team-tools.aurorascan 192.168.1.0/24 --profile recon --json # Use GUI interface (where available) python -m red-team-tools.cipherspear --gui`
6

## Integrate with Ai:oS

For advanced usage, integrate tools with the Ai:oS meta-agent system:

`# Boot Ai:oS with security manifest python aios --manifest aios/examples/manifest-security-response.json --env AGENTA_SECURITY_TOOLS=AuroraScan,CipherSpear -v boot # Check security agent health python aios -v exec security.sovereign_suite # Run natural language prompts python aios -v prompt "scan network and check for vulnerabilities"`

ℹ️ Ai:oS Integration: Ai:oS provides meta-agent coordination, automatic health monitoring, and agentic workflows. It's optional but recommended for advanced users.

7

## Best Practices

Follow these best practices for safe and effective use:

- Always get authorization before testing any system
- Start with --demo mode to understand tool behavior
- Use --health checks before production use
- Test in isolated environments (VMs, lab networks)
- Read tool documentation before running scans
- Respect rate limits to avoid disruption
- Log all activities for audit trails
- Report findings responsibly via proper channels

8

## Next Steps

Ready to dive deeper? Here are some suggestions:

🛠️
Explore All Tools
🤖
ML Algorithms
💬
Read FAQ
📖
View on GitHub

- Read the FAQ for common questions
- Explore the ML & Quantum algorithms
- Join discussions on GitHub Issues
- Contribute improvements via Pull Requests
- Star the repo to support the project

🎉 Congratulations! You're now ready to explore the Red Team Tools Suite. Remember: with great power comes great responsibility. Use these tools ethically, legally, and with curiosity.

⚠️ Need Help? If you encounter issues, check the FAQ or open an issue on GitHub. The community is here to help!