Documentation

Installation & Running

There are two primary ways to install and run Ducky: from a release executable or from the source code.

For Users (Recommended)

This method uses the pre-packaged executable and is the easiest way to get started.

1. Navigate to the Download section on the homepage or go to the [GitHub Releases](https://github.com/thecmdguy/Ducky/releases) page.
2. Download the latest executable (`Ducky.exe`).
3. Place the downloaded file in any directory you like (e.g., your Desktop or a dedicated 'Tools' folder).
4. Exxtract it and ouble-click the Ducky application That's it!

For Developers (From Source)

Follow these steps if you want to run the latest code or contribute to the project.

1. Prerequisites: Ensure you have Python 3.8+ (64-bit recommended) and Git installed.
2. Clone the Repository:

   git clone https://github.com/thecmdguy/Ducky.git
   cd Ducky

3. Run the Setup Script: For a simple, automated setup on Windows, just double-click the `setup.bat` file in the project's root directory. This will create a virtual environment, install all dependencies, and create a desktop shortcut for you.
4. Manual Installation: Alternatively, you can run the installation steps yourself:

   python -m venv venv
   .\venv\Scripts\activate
   pip install -e .

5. Run Ducky: If you used the setup script, use the new desktop shortcut. If you installed manually, you can run the application from your terminal by simply typing its name:

   ducky

Core Features Guide

Ducky is organized into several key modules, accessible from the sidebar.

Multi-Protocol Terminal

The heart of Ducky is its powerful, tabbed terminal. You can create multiple sessions in a single window, making it easy to manage connections to many devices at once.

• SSH & Telnet: Securely connect to routers, switches, servers, and other network devices using standard protocols.
• Serial (COM): Directly connect to devices for initial configuration or recovery using a console cable. Ducky automatically detects available COM ports.
• Session Manager: Save your terminal sessions to a log file for later review.

Network & Security Tools

A suite of essential utilities for network analysis and security testing. These tools are designed for quick and easy access without leaving the application.

Topology Mapper

The Topology Mapper is designed to give you a visual overview of your local network. When you initiate a scan, Ducky performs a two-stage discovery process:

1. ICMP Scan: It sends a "ping" to every IP address in your auto-detected subnet to find live hosts that are responding.
2. SNMP Query: For each device that responds, Ducky sends an SNMP "Get" request. If the device has SNMP enabled (common for routers, switches, and printers), it will respond with its configured hostname and a system description.

The results are then displayed on an interactive map, where you can click on any device to see all the information Ducky has gathered about it.

Contributing to Ducky

Ducky is an open-source project, and community contributions are highly encouraged! Whether you're a developer, a designer, or a user with a great idea, there are many ways to help.

• Reporting Bugs: If you find a bug, please open an issue on our GitHub Issues page.
• Suggesting Features: Have an idea for a new tool? Let us know by opening a feature request.
• Writing Code: If you'd like to contribute code, please fork the repository and submit a pull request with your changes.