Skip to content

SETUP_AND_USE.md

Latest commit

 

History

History
165 lines (115 loc) · 3.28 KB

SETUP_AND_USE.md

File metadata and controls

165 lines (115 loc) · 3.28 KB
Raw

Zypheron Setup and Usage Guide

This guide covers first-time setup and the current day-to-day CLI workflow.

First-Time Setup

After installing Zypheron:

zypheron --version
zypheron doctor

If you installed from source and still need Python-side packages:

zypheron install-deps --all

If you want Zypheron to install critical external tools for you:

zypheron tools install-all --critical-only --yes

Environment Checks

Useful validation commands:

zypheron doctor
zypheron tools check
zypheron ai status

For repo-level local validation of the optional API service path:

./scripts/setup_api_test_env.sh --allow-online
./scripts/setup_ai_test_env.sh --allow-online
./scripts/run_all_tests.sh --ci
./scripts/local_smoke_test.sh --setup-api-env --allow-online

If you are running on Kali or WSL and want environment-specific checks:

zypheron kali detect

AI Setup

Zypheron supports local and hosted providers.

Common setup patterns:

zypheron config set-key anthropic
zypheron config set-key openai
zypheron config set-key deepseek
zypheron config get-providers

In the TUI, selecting a hosted model without a configured key will now prompt for the API key and store it for reuse.

For local models, configure Ollama separately and then select an Ollama model in Zypheron.

Tool Installation

Check the current tool inventory:

zypheron tools check
zypheron tools list
zypheron tools list --missing

Install tools:

zypheron tools install nmap
zypheron tools install nuclei
zypheron tools install-all --critical-only --yes
zypheron tools install-all --yes

If you prefer to manage tools yourself, just keep tools check and doctor clean.

Common Workflows

Launch the TUI

zypheron
zypheron tui

Recon and Scanning

zypheron scan example.com
zypheron scan example.com --web
zypheron recon example.com

AI-assisted Dorking

zypheron dork "admin panels"
zypheron dork " exposed login portals " --ai-guided

AI Chat

zypheron chat "How would you approach this host?"

Sessions and Workflows

zypheron workflow list
ZYPHERON_ENABLE_AUTOPENT=1 zypheron autopent example.com
zypheron session list

Configuration

Useful config commands:

zypheron config show
zypheron config path
zypheron config get ai.provider
zypheron config set ai.provider ollama
zypheron config set ai.model llama3.2:3b

Typical config locations:

  • Linux/macOS: ~/.zypheron/config.json
  • Windows: %APPDATA%\\zypheron\\config.json

Updating

If you installed a release build:

zypheron update check

If you installed from source, update by pulling the repo and rerunning the bootstrap script:

git pull
bash scripts/install/setup-hybrid.sh

Notes

  • some workflows depend on external tools being present locally
  • AI features depend on either configured hosted keys or a local model runtime
  • optional API, Redis, and Prometheus services are not required for core CLI usage
  • not every command is equally mature; use zypheron --help and command help output as the source of truth for your build
  • Enterprise Teams, streaming chat protocol support, and full autonomous exploitation are deferred for the OSS release candidate