Skip to content

Commit 293a6fa

Browse files
committed
update
1 parent 3f785f7 commit 293a6fa

2 files changed

Lines changed: 74 additions & 2 deletions

File tree

README.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
<h2> Qompass AI Network Tooling </h2>
66

7-
87
![Repository Views](https://komarev.com/ghpvc/?username=qompassai-network)
98
![GitHub all releases](https://img.shields.io/github/downloads/qompassai/network/total?style=flat-square)
109

@@ -35,6 +34,80 @@
3534
<a href="./LICENSE-QCDA"><img src="https://img.shields.io/badge/license-Q--CDA-lightgrey.svg" alt="License: Q-CDA"></a>
3635
</p>
3736

37+
### How do get this going with one copy/paste
38+
** Recommend to read the script in scripts/nix.sh first THEN copy and paste the below**
39+
40+
```bash
41+
git clone https://github.com/qompassai/network.git
42+
cd network
43+
chmod +x scripts/nix.sh
44+
./scripts/nix.sh
45+
```
46+
47+
### 2. That's It!
48+
49+
The script automatically:
50+
-**Installs Nix** (if not already installed)
51+
-**Enables flakes and experimental features**
52+
-**Configures optimal settings** (caching, substituters, etc.)
53+
-**Tests all tools** to verify everything works
54+
-**Drops you into the development environment**
55+
56+
---
57+
58+
## 🛠️ What This Gives You
59+
60+
### 🔐 **Encryption Tools**
61+
- **`rage`** - Modern file encryption
62+
- **`age`** - Original age encryption
63+
- **`openssl`** - Cryptography toolkit
64+
65+
### 🔨 **Hash Tools**
66+
- **`hash-utils blake3 <file>`** - BLAKE3 hashing
67+
- **`hash-utils sha3-256 <file>`** - SHA3-256 hashing
68+
- **`hash-utils sha512 <file>`** - SHA-512 hashing
69+
70+
### 🌐 **Network Tools**
71+
- **`networkmanager`** - Network management
72+
- **`unbound`** - Secure DNS
73+
- **`nmap`** - Network scanning
74+
- **`tcpdump`** - Network analysis
75+
76+
### Build just the hash utilities
77+
78+
```
79+
nix build .#hash-utils
80+
./result/bin/hash-utils blake3 somefile.txt
81+
```
82+
Build network setup script
83+
```
84+
nix build .#networkmanager-setup
85+
./result/bin/networkmanager-setup
86+
```
87+
88+
### Run Tools Without Installing
89+
90+
Run tools directly from GitHub
91+
```
92+
nix run github:qompassai/network#hash-utils blake3 myfile.txt
93+
```
94+
95+
### Use Again Later
96+
97+
```bash
98+
cd /path/to/qompassai/network
99+
nix develop
100+
```
101+
---
102+
103+
## 💡 Examples
104+
105+
### **Encrypt a file:**
106+
107+
Generate a key and encrypt
108+
109+
rage-keygen -o mykey.txt
110+
rage -e -i mykey.txt -o secret.age plaintext.txt
38111

39112
<details id="Contact">
40113
<summary><strong>Contact Qompass AI</strong></summary>

scripts/nix.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ fi
3030

3131
mkdir -p "$USER_HOME/.config/nix"
3232

33-
# Create backup if config exists
3433
if [ -f "$USER_HOME/.config/nix/nix.conf" ]; then
3534
BACKUP_FILE="$USER_HOME/.config/nix/nix.conf.backup.$(date +%Y%m%d-%H%M%S)"
3635
cp "$USER_HOME/.config/nix/nix.conf" "$BACKUP_FILE"

0 commit comments

Comments
 (0)