Skip to main content

🛡️ Cyberzard & CyberPanel Cleanup

PyPI version PyPI downloads Docs Build Docs License: MIT Python Status AI Optional Offline‑first

Modern incident triage for CyberPanel:

  • 🧰 Legacy bash cleanup scripts (basic & advanced)
  • 🤖 Cyberzard — an AI‑assisted, safety‑constrained CLI for scanning, explaining, and planning remediation


📖 Table of Contents

🤖 Cyberzard — AI Security CLI

Experimental preview. Interfaces may change until v0.1.

Features

Area What you get
Multi‑source scanning Files, processes, cron, services, users, SSH keys, encrypted files
Severity scoring Critical/High/Medium/Low with rationale
Evidence preservation Optional hashing/archiving prior to actions
Dry‑run planning Generate remediation plan JSON first
AI reasoning (optional) Summaries, prioritization, advice (OpenAI/Anthropic/xAI/none)
ReAct loop Safe tool schema, sandboxed helpers
Output Pretty tables + JSON
Chat mode Interactive, permission‑aware assistant
TUI (optional) Simple terminal UI for scan results
Email stack hardening scan + AI summary + guided execution

Install & Use

# Basic install
pip install cyberzard

# With AI provider extras
pip install cyberzard[openai]      # OpenAI support
pip install cyberzard[anthropic]   # Anthropic Claude support
pip install cyberzard[xai]         # xAI Grok support
pip install cyberzard[providers]   # All AI providers
pip install cyberzard[all]         # Everything (AI + TUI + MCP)

With pipx (recommended for CLI tools - isolated environment):

pipx install cyberzard
pipx install 'cyberzard[openai]'

With uv (fast modern package manager):

uv tool install cyberzard
# Or run without installing:
uvx cyberzard scan

Option 2: One-liner installer (Linux binary)

bash -c "$(curl -fsSL https://raw.githubusercontent.com/elwizard33/Cyberzard/main/scripts/install.sh)"

Upgrade later:

# PyPI upgrade
pip install --upgrade cyberzard

# Binary upgrade
cyberzard --upgrade                    # quick upgrade using global flag
cyberzard upgrade --channel stable     # explicit upgrade command

Option 3: Install from source (development)

git clone https://github.com/elwizard33/Cyberzard.git
cd Cyberzard
python3 -m venv .venv && source .venv/bin/activate
python -m pip install -U pip setuptools wheel
pip install -e .[openai]   # or .[anthropic] or .[dev]

Notes:

Optional TUI (terminal UI):

pip install 'textual>=0.60'
cyberzard tui

Common commands:

# Scan and pretty print
cyberzard scan

# JSON findings
cyberzard scan --json > findings.json

# Advice (static + optional AI enrichment)
CYBERZARD_MODEL_PROVIDER=openai OPENAI_API_KEY=sk-... cyberzard advise

# Explain findings (AI)
OPENAI_API_KEY=sk-... cyberzard explain --provider openai

# Bounded reasoning loop (ReAct)
OPENAI_API_KEY=sk-... cyberzard agent "Top suspicious processes and rationale" --steps 4

# Interactive chat (permission‑aware)
cyberzard chat
cyberzard chat --auto-approve --max-probes 8

# Remediation (requires explicit flags)
cyberzard remediate --delete --kill --preserve

# n8n deployment assistant (generate + optional apply)
# Native (OpenLiteSpeed reverse-proxy):
cyberzard n8n-setup --domain example.com --subdomain n8n --mode native --basic-auth --out-dir ./out

# Cloudflare Tunnel (docker compose + cloudflared):
cyberzard n8n-setup --domain example.com --subdomain n8n --mode tunnel --out-dir ./out

# Write-only JSON summary (no apply):
cyberzard n8n-setup --domain example.com --mode native --write-only --out-dir ./out --overwrite

# Email security (scan + hardening preview)
cyberzard email-security --dry-run

# Execute guided (still dry-run by default until --no-dry-run)
cyberzard email-security --run --dry-run --max-risk medium

# Full remediation guide + optional execution
cyberzard email-fix --run --dry-run --max-risk low

# JSON output (no rich)
cyberzard email-security --json --run --dry-run

Troubleshooting

  • Editable install error (missing build_editable hook): upgrade pip/setuptools/wheel in a venv, or use non‑editable install:
    • python -m pip install -U pip setuptools wheel
    • pip install .[openai] (or .[anthropic] or just .)

Environment

Var Purpose Default
CYBERZARD_PROVIDER openai, anthropic, xai, none none
OPENAI_API_KEY API key when provider=openai
ANTHROPIC_API_KEY API key when provider=anthropic
XAI_API_KEY API key when provider=xai
CYBERZARD_EVIDENCE_DIR Evidence dir /var/lib/cyberzard/evidence
CYBERZARD_DRY_RUN Global dry‑run true

Check available providers:

cyberzard providers

Safety Model

  • No raw shell; curated, allow‑listed tools only
  • Dry‑run by default; explicit flags to delete/kill
  • Reasoning step cap; sandboxed helpers
  • AI optional; offline works fine

MCP Server (Model Context Protocol)

Cyberzard can act as an MCP server, exposing all its security tools to AI agents like Claude:

# Start MCP server (stdio transport for Claude Desktop)
cyberzard mcp

# Start with SSE transport for web clients
cyberzard mcp --transport sse --port 8080

# Start with streamable HTTP transport
cyberzard mcp --transport streamable-http --port 8080

Configure in Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "cyberzard": {
      "command": "cyberzard",
      "args": ["mcp"],
      "env": {}
    }
  }
}

Available tools via MCP:

  • scan_server - Full security scan
  • read_file - Safe file reading
  • propose_remediation - Generate remediation plans
  • CyberPanel management (websites, databases, email, DNS, SSL, backups, firewall)

CyberPanel Integration

Cyberzard integrates with CyberPanel's REST API for server management:

# Set CyberPanel credentials
export CYBERPANEL_HOST=https://your-server:8090
export CYBERPANEL_USER=admin
export CYBERPANEL_PASS=your-password

# Use via chat mode
cyberzard chat
> List all websites on this server
> Create a new database called myapp_db

# Or programmatically in Python
from cyberzard.cyberpanel import CyberPanelClient
client = CyberPanelClient()
websites = await client.list_websites()

Supported operations:

  • Websites: List, create, delete, suspend/unsuspend
  • Databases: List, create, delete MySQL/MariaDB databases
  • Email: Accounts, forwarders, DKIM
  • DNS: Records management
  • SSL: Issue/renew certificates
  • Firewall: CSF rules, block/unblock IPs
  • Backups: Create, restore, schedule

Enhanced TUI (Terminal UI)

The enhanced TUI provides a split-panel chat interface:

# Install TUI dependencies
pip install 'cyberzard[tui]'

# Run chat TUI
cyberzard chat --tui

# Or legacy scan TUI
cyberzard tui

Features:

  • Split layout: Conversation on left, tools on right
  • Real-time tool tracking: See tool calls as they execute
  • Streaming responses: Watch AI responses as they generate
  • Keyboard shortcuts: Ctrl+L (clear), Ctrl+T (toggle tools), q (quit)

🧰 Legacy Cleanup Scripts

Overview

Basic and Advanced bash scripts to triage and clean common artifacts from the November CyberPanel attacks.

Capability Basic Advanced
Diagnostics (files, processes, encrypted files)
Cleanup of artifacts
User + SSH key audit
Interactive confirmations
Extra post‑hardening tips

Quick Start

Basic:

sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/elwizard33/Cyberzard/main/scripts/wizard_cleanup.sh)"

Advanced:

sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/elwizard33/Cyberzard/main/scripts/advanced_wizard_cleanup.sh)"

Decrypt Helpers


🤝 Contributing

Please read the Issue Guide before filing.

  • Small, focused PRs with tests/docs updates are welcome
  • Clearly document environment and reproduction steps

⚠️ Disclaimer

These tools are provided as‑is, without warranty. Validate outputs before acting in production. Maintain backups and snapshots.


Useful References

Release files for cyberzard 0.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cyberzard 0.1.20
File Size Uploaded
cyberzard-0.1.20.tar.gz 105.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cyberzard 0.1.20
File Interpreter ABI Platform
cyberzard-0.1.20-py3-none-any.whl Python 3 none any Details

Total release size: 221.9 kB

Release files / cyberzard-0.1.20.tar.gz

Download URL cyberzard-0.1.20.tar.gz
Size 105.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2cf13f797d45df448414dd3a06cfcf6df1dfe2d4ff6cf937ed8316c45dfa187c
BLAKE2b-256 checksum
How to use checksums
e35b55b3063b98545f280f872c97dd870668cc074a219df52085e1837e164e32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 29, 2025.

Transparency log

Release files / cyberzard-0.1.20-py3-none-any.whl

Download URL cyberzard-0.1.20-py3-none-any.whl
Size 116.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
deed0e84fc5d4b50f20aa7c10fda7786962626dfaf1bc7b409868f338e37f22a
BLAKE2b-256 checksum
How to use checksums
157729cf29c704fd8988a8606cf08f0ebac73fbe8051a3ee528b7fb6e01b4e7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 29, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.20 This release

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page