📚 Zypheron Documentation

Welcome to the Zypheron documentation! This directory contains all the guides and references you need to use Zypheron effectively.

📖 Documentation Index

Essential Guides

Document	Description	Status
SETUP.md	Complete installation and configuration guide	✅ Complete
CLI_GUIDE.md	Full CLI command reference	✅ Complete
TOOL_CHAINS.md	Tool chain configuration guide	✅ Complete
DEV_STATUS.md	Current development status and roadmap	✅ Complete

Root Documentation

Document	Description
../README.md	Main project README
../CHANGELOG.md	Version history
../SECURITY.md	Security policy
../TESTING.md	Testing guide
../LICENSE	MIT License

🚀 Quick Start

Installation → Start with SETUP.md
First Steps → See CLI_GUIDE.md Quick Examples
Tool Chains → Configure workflows in TOOL_CHAINS.md
Development → Check DEV_STATUS.md for features

📂 Documentation Structure

docs/
├── README.md           # This file - documentation index
├── SETUP.md            # Installation and configuration
├── CLI_GUIDE.md        # Complete command reference
├── TOOL_CHAINS.md      # Tool chain configuration
├── DEV_STATUS.md       # Development status
└── archive/            # Old/deprecated documentation

🎯 Documentation by Topic

Getting Started

Commands

Configuration

Advanced Topics

🔧 Common Tasks

Network Scanning

# Quick scan
zypheron scan example.com

# Full pentest
zypheron scan example.com --full --ai-analysis

📖 Full Guide →

Binary Analysis

# Reverse engineering
zypheron reverse-eng /path/to/binary --chain reverse_engineering

# Binary exploitation
zypheron pwn /path/to/binary --tool checksec

📖 Full Guide →

API Security

# API testing
zypheron api-pentest https://api.example.com --bola --bfla

📖 Full Guide →

Tool Management

# Check tools
zypheron tools check

# Install all critical tools
zypheron tools install-all --critical-only

📖 Full Guide →

🆘 Troubleshooting

Having issues? Check these resources:

Setup Troubleshooting - Installation issues
CLI Guide Examples - Usage examples
GitHub Issues - Known issues
GitHub Discussions - Community help

📊 Feature Status

Current status of major features:

Feature	Status	Documentation
Network Scanning	✅ Complete	CLI Guide
Web Security	✅ Complete	CLI Guide
Binary Analysis	✅ Complete	CLI Guide
API Testing	✅ Complete	CLI Guide
Forensics	✅ Complete	CLI Guide
AI Integration	✅ Complete	Setup Guide
AI Dorking	🚧 In Progress	CLI Guide
Tool Chains	✅ Complete	Tool Chains

See DEV_STATUS.md for complete feature list and roadmap.

🤝 Contributing

Want to improve the documentation?

Documentation lives in the docs/ directory
Use Markdown format
Keep language clear and concise
Include code examples
Test all commands before documenting

See DEV_STATUS.md for contribution guidelines.

📝 Documentation Standards

Format

Use Markdown with GitHub-flavored extensions
Include table of contents for long documents
Use code blocks with language specification
Include examples for all commands

Structure

Start with overview and purpose
Include quick examples early
Provide detailed reference later
End with related resources

Code Examples

# Always include comments
zypheron scan example.com     # Basic usage

# Show expected output when helpful
zypheron tools check
# Output: Found 25/30 tools installed

🔗 External Resources

GitHub: https://github.com/KKingZero/Cobra-AI
Issues: https://github.com/KKingZero/Cobra-AI/issues
Discussions: https://github.com/KKingZero/Cobra-AI/discussions

📅 Documentation Updates

This documentation is regularly updated. Last major revision: November 2025

Check DEV_STATUS.md for the most current feature information.

Need help? Start with SETUP.md or open an issue on GitHub!