Docs / Getting started / Quick Start
GitHub

Getting started

Quick Start

Open The Console

cd Kittysploit-framework
source venv/bin/activate
python kittyconsole.py

The console prompt is kitty>. Accept the usage charter before running modules.

Verify Installation

banner
status
doctor
sync now
bannerDisplays version and runtime identity.
statusShows workspace, indexed modules, jobs, and sessions.
doctorChecks Python, dependencies, Docker, assets, and optional services.
sync nowRefreshes the module index used by search.

Workspace And Scope

workspace create first-scan
workspace use first-scan
scope add 127.0.0.1
host add 127.0.0.1 --note "authorized local target"

Every scan should run inside a named workspace with explicit scope. This keeps history, hosts, findings, and campaign output together.

First Scan

scanner -u http://127.0.0.1 --threads 5
vuln list
campaign --preview

Use scanner -u for broad HTTP coverage, then review findings before running more specific modules.

Module Families

FamilyPurposeExample
auxiliarySupport modules: scan, fuzz, collection, service helpers.auxiliary/scanner/portscan/tcp
scannerVulnerability and service probes.scanner/http/security_headers_detect
payloadsCode executed by compatible exploits.payloads/singles/cmd/unix/bash_reverse_tcp
listenersReceives reverse connections.listeners/multi/reverse_tcp
encodersPayload or transport encoding.encoders/cmd/base64
workflowChains multiple modules.workflow/simple_workflow
shortcutOne-shot command automation.shortcut/example_shortcut

Useful Navigation

help
search security_headers
show options
back
history

These commands are enough to inspect the catalog, load a module, review options, and keep track of the current session.