NAME
witchcraft - A versatile netrunner toolkit for cybersecurity.

SYNOPSIS
witchcraft [MODULE_NAME] [OPTION]... [FILE]... [IP]...

DESCRIPTION
WITCHCRAFT is a powerful cybersecurity toolkit providing tools for forensic analysis, OSINT, scanning, backups, data copying, and penetration testing for applications and APIs. Its flexibility makes it suitable for a wide range of security tasks.

EXAMPLES

• witchcraft map.local
  Map all open local connections.

• witchcraft search.meta --keyword user_name
  Search for the user_name keyword across over 1000 sites.

• witchcraft map.default --target example.com
  Perform a default port scan on the specified target.

INSTALLATION
The project initially includes a set of default files created using advanced data analysis techniques. Final versions are merged into the main project.

• GitHub Installation:
  Visit [witchcraft GitHub repository](https://github.com/cosmic-zip/witchcraft).
  Go to releases, download the latest version, unzip the file, and locate installer.sh and uninstall.sh.

  ```bash sudo bash installer.sh ```

• Snap Package Installation:
  ```bash snap install witchcraft-cybersecurity ```

• Build from Source:
  ```bash git clone https://github.com/cosmic-zip/witchcraft cd witchcraft sudo bash build-devel.sh ```

  Locate the dist folder, unzip the file, and use installer.sh and uninstall.sh.

  The script prompts for root access, creates a release folder, and places built executables inside. It also provides options for downloading archives for OSINT and wordlists required for IP lookup operations.

Spellbook Package Includes:

• Unique Wordlists: moth (16GB) and ladybug (1GB)
• Default Credentials Database
• IP Geolocation and Reputation/Score
• Social Media Pages for Evil Twin Attacks
• General Wordlists for Directories and Subdomains
• MAC Address Vendor Database
• Usernames Wordlist
• XSS Wordlist
• And more!

Optional Wordlists and Malware Signatures
These files (700MB) can be downloaded using:
```bash git clone https://github.com/cosmic-zip/witchcraft-wordlists /var/spellbook/ ```

EVILPAGES
Clone pages into /var/spellbook/evilpages using the SingleFile extension or similar tools. Example:
```bash witchcraft server.eviltwin --address 127.0.0.1:9000 --path foo/bar/index.html ``` [SingleFile Extension](https://addons.mozilla.org/en-US/firefox/addon/single-file/)

RC FILE
To log interactions, create .witchrc in your home folder and add:
```plaintext path_log_file=~/my_frog.jsonl ``` Replace ~/ with a specific path if desired.

PLUGINS
Witchcraft supports extensions via static files, Rust code, and db.json. This file allows integration of terminal-based operations. Example:

Custom Command in Terminal:
```bash mycommand --flag value --key value --some foo ```

Entry in db.json:
```json { "name": "mycommand", "description": "My command does something cool", "command": "mycommand --flag @@flag --key @@some_name_for_the_key" } ```

Final Command in Witchcraft:
```bash mycommand --flag foo --some_name_for_the_key bar ```

You can assign any name to a flag. Note that flags are not positional.
Repeating a flag will not create a list of values. If a flag is repeated, only the first occurrence will be accepted. This design covers 98% of CLI interactions. Edge cases are not supported.

LICENSE AND TERMS
This project is licensed under the GNU General Public License v3.0.
WITCHCRAFT includes IP2Proxy® LITE and cinsscore® databases.