Skip to content

Commit 420a97b

Browse files
docs: auto-generate README.md from index.md
1 parent 9a7618d commit 420a97b

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,20 @@
66

77
# Nix 4 cyber 🛡️
88

9-
**Nix 4 Cyber** (or n4c) is a framework that uses the **Nix package manager** to provide reproducible cybersecurity **toolkits**. The project is organized into categories (e.g., OSINT, Web, Networking), each with a shell.nix file that defines its specific software environment.
9+
**Nix 4 Cyber** (or n4c) is a framework that uses the **Nix package manager** to
10+
provide reproducible cybersecurity **toolkits**. The project is organized into
11+
categories (e.g., OSINT, Web, Networking), each with a shell.nix file that
12+
defines its specific software environment.
1013

11-
This approach ensures that all dependencies are isolated and consistent, allowing users to perform security tasks with a predictable set of tools. The official documentation, including a full tool list and **usage examples**, is available at [n4c.hadi.diy](https://n4c.hadi.diy).
14+
This approach ensures that all dependencies are isolated and consistent,
15+
allowing users to perform security tasks with a predictable set of tools. The
16+
official documentation, including a full tool list and **usage examples**, is
17+
available at [n4c.hadi.diy](https://n4c.hadi.diy).
1218

1319
## 🚀 Usage
1420

15-
To use Nix 4 cyber, you need to have Nix installed on your system. You can then start the shell with the following command:
21+
To use Nix 4 cyber, you need to have Nix installed on your system. You can then
22+
start the shell with the following command:
1623

1724
```bash
1825
nix develop --refresh github:nix4cyber/n4c#<toolkit>
@@ -26,17 +33,19 @@ nix develop --refresh github:nix4cyber/n4c#osint
2633

2734
## 🧰 Available Toolkits
2835

29-
Here are the currently available environments, each providing a curated set of tools for its specific domain:
36+
Here are the currently available environments, each providing a curated set of
37+
tools for its specific domain:
3038

3139
### 🕸️ Web (web)
3240

33-
For web application penetration testing, including directory busting, spidering, and vulnerability analysis.
41+
For web application penetration testing, including directory busting, spidering,
42+
and vulnerability analysis.
3443
[See tools and guides &rarr;](https://n4c.hadi.diy/web/)
3544

3645
### 🕵️ OSINT (osint)
3746

38-
A collection of tools for Open Source Intelligence gathering from public sources.
39-
[See tools and guides &rarr;](https://n4c.hadi.diy/osint/)
47+
A collection of tools for Open Source Intelligence gathering from public
48+
sources. [See tools and guides &rarr;](https://n4c.hadi.diy/osint/)
4049

4150
### 🌐 Network (network)
4251

@@ -50,8 +59,8 @@ Tools focused on password and hash cracking.
5059

5160
### 👑 Privilege Escalation (privesc)
5261

53-
Scripts and tools to help with enumerating and exploiting privilege escalation vectors.
54-
[See tools and guides &rarr;](https://n4c.hadi.diy/privesc/)
62+
Scripts and tools to help with enumerating and exploiting privilege escalation
63+
vectors. [See tools and guides &rarr;](https://n4c.hadi.diy/privesc/)
5564

5665
### 🔍 Forensics (forensics)
5766

@@ -74,8 +83,11 @@ Add the following in your shell config:
7483

7584
```bash
7685
function n4c() {
86+
category=${1:-all}
87+
shift
88+
args=${*}
89+
nix develop "github:nix4cyber/n4c#${category}" ${args} # -c zsh # Escape the $ with ''$ in nix
7790
# mkdir -p /tmp/$(date +"%d%m%y") && cd /tmp/$(date +"%d%m%y") # To create a temporary directory
78-
nix develop --refresh "github:nix4cyber/n4c#${1:-all}" # -c zsh # Escape the $ with ''$ in nix
7991
}
8092
```
8193

@@ -87,8 +99,15 @@ n4c <category>
8799

88100
## ⚖️ Disclaimer
89101

90-
Nix 4 Cyber is intended solely for lawful, ethical, and educational purposes. It is designed to assist cybersecurity professionals, researchers, and students in conducting authorized security assessments, penetration testing, and digital forensics within environments where they have explicit permission to operate.
102+
Nix 4 Cyber is intended solely for lawful, ethical, and educational purposes. It
103+
is designed to assist cybersecurity professionals, researchers, and students in
104+
conducting authorized security assessments, penetration testing, and digital
105+
forensics within environments where they have explicit permission to operate.
91106

92-
By using this project, you agree to comply with all applicable laws and regulations. The maintainers of Nix 4 Cyber are not responsible for any misuse of the tools or scripts provided. Unauthorized or malicious use of this project is strictly prohibited and may violate local, national, or international laws.
107+
By using this project, you agree to comply with all applicable laws and
108+
regulations. The maintainers of Nix 4 Cyber are not responsible for any misuse
109+
of the tools or scripts provided. Unauthorized or malicious use of this project
110+
is strictly prohibited and may violate local, national, or international laws.
93111

94-
Use responsibly. Always obtain proper authorization before conducting any security testing.
112+
Use responsibly. Always obtain proper authorization before conducting any
113+
security testing.

0 commit comments

Comments
 (0)