> For the complete documentation index, see [llms.txt](https://docs.nimux.wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nimux.wiki/overview.md).

# Overview

nimux is a pure-Nim network enumeration and remote execution toolkit for authorized security assessment work.

It is built around native protocol implementations instead of shelling out to common external tools. The goal is a fast single operator binary for discovery, authentication checks, Active Directory enumeration, Kerberos workflows, file transfer, and remote execution.

### Core ideas

* One primary operator binary: `nimux`
* Native protocol clients for SMB, LDAP, Kerberos, WinRM, MSSQL, RDP, SSH, FTP, VNC, NFS, AFP, WebDAV, HTTP, MySQL, and PostgreSQL
* HTTP directory/file/vhost discovery, DNS subdomain discovery, and SMB share spidering for read-only enumeration
* JSONL output for automation
* Human-readable boxed output for interactive work
* Kerberos ccache support for ticket-based operations
* Built-in SMB file transfer and remote execution modes
* On-demand Windows helper builds for selected execution modes

### Legal notice

Use nimux only on systems you own or are explicitly authorized to assess. The tool includes functionality that can modify Active Directory objects, request Kerberos tickets, run commands remotely, and extract sensitive material from systems where the operator has sufficient privileges. The author assumes no responsibility or liability for misuse, damage, or legal consequences caused by unauthorized use.

### Current version

`nimux v1.0.5`

Author: Chokri Hammedi (blue0x1)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nimux.wiki/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
