karnel-termux 4.17.9 → 4.17.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -12
- package/docs/ARCHITECTURE/index.md +7 -1
- package/docs/CHANGELOG.md +52 -0
- package/docs/_config.yml +0 -2
- package/docs/_layouts/base.html +21 -0
- package/docs/assets/css/style.scss +34 -0
- package/docs/cli/index.md +13 -7
- package/docs/doctor/index.md +6 -0
- package/docs/index.md +14 -13
- package/docs/karnel/ai/index.md +17 -0
- package/docs/karnel/auto/index.md +17 -0
- package/docs/karnel/db/index.md +17 -0
- package/docs/karnel/deploy/index.md +17 -0
- package/docs/karnel/dev/index.md +17 -0
- package/docs/karnel/editor/index.md +17 -0
- package/docs/karnel/games/index.md +17 -0
- package/docs/karnel/lang/index.md +17 -0
- package/docs/karnel/network/index.md +17 -0
- package/docs/karnel/npm/index.md +17 -0
- package/docs/karnel/osint/index.md +17 -0
- package/docs/karnel/plugin/index.md +17 -0
- package/docs/karnel/security/index.md +17 -0
- package/docs/karnel/shell/index.md +17 -0
- package/docs/karnel/ui/index.md +17 -0
- package/docs/karnel/utils/index.md +21 -0
- package/docs/karnel/voice/index.md +17 -0
- package/docs/troubleshooting/index.md +7 -1
- package/karnel/RELEASE_COMMIT +1 -1
- package/karnel/bin/karnel +1 -1
- package/karnel/cli/commands/brain.sh +2 -2
- package/karnel/cli/commands/doctor/code_exec.sh +4 -0
- package/karnel/cli/commands/doctor/code_langs.sh +1 -1
- package/karnel/cli/commands/doctor/fixes.sh +14 -2
- package/karnel/cli/commands/doctor.sh +33 -8
- package/karnel/cli/commands/open.sh +31 -74
- package/karnel/cli/commands/pg.sh +22 -5
- package/karnel/cli/commands/show.sh +5 -0
- package/karnel/cli/commands/update.sh +3 -3
- package/karnel/modules/shell.sh +1 -1
- package/karnel/tools/ai/cline/install.sh +9 -1
- package/karnel/tools/ai/cursor-cli/install.sh +2 -1
- package/karnel/tools/ai/goose/install.sh +1 -1
- package/karnel/tools/ai/hermes-agent/install.sh +1 -1
- package/karnel/tools/ai/kiro/install.sh +9 -1
- package/karnel/tools/deploy/supabase/install.sh +1 -1
- package/karnel/tools/plugins/install.sh +17 -3
- package/karnel/tools/security/amass/install.sh +1 -1
- package/karnel/tools/security/burpsuite/install.sh +1 -1
- package/karnel/tools/security/ffuf/install.sh +1 -1
- package/karnel/tools/security/gobuster/install.sh +1 -1
- package/karnel/tools/security/subfinder/install.sh +1 -1
- package/karnel/tools/security/zap/install.sh +1 -1
- package/karnel/tools/utils/all.sh +2 -0
- package/karnel/tools/utils/herdr/README.md +33 -0
- package/karnel/tools/utils/herdr/install.sh +160 -0
- package/karnel/tools/utils/zork/zork.sh +8 -3
- package/karnel/utils/agent_actions.sh +12 -4
- package/karnel/utils/log.sh +1 -1
- package/karnel/utils/tools.sh +1 -1
- package/karnel/utils/version.sh +1 -1
- package/package.json +2 -2
- package/scripts/completion.bash +1 -1
- package/scripts/completion.zsh +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
10
|
<a href="https://github.com/israelmarques1024-dotcom/karnel-termux">
|
|
11
|
-
<img src="https://img.shields.io/badge/version-4.17.
|
|
11
|
+
<img src="https://img.shields.io/badge/version-4.17.13-0078D4?style=for-the-badge" alt="Version">
|
|
12
12
|
</a>
|
|
13
13
|
<a href="https://www.npmjs.com/package/karnel-termux">
|
|
14
14
|
<img src="https://img.shields.io/npm/v/karnel-termux?style=for-the-badge&logo=npm&color=cb3837" alt="npm">
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
<a href="https://termux.dev/">
|
|
23
23
|
<img src="https://img.shields.io/badge/platform-Termux%20%7C%20Android-0078D4?style=for-the-badge" alt="Platform">
|
|
24
24
|
</a>
|
|
25
|
-
<a href="https://
|
|
26
|
-
<img src="https://img.shields.io/badge/Site-karneltermux.
|
|
25
|
+
<a href="https://israelmarques1024-dotcom.github.io/karnel-termux">
|
|
26
|
+
<img src="https://img.shields.io/badge/Site-karneltermux.github.io-0078D4?style=for-the-badge" alt="Website">
|
|
27
27
|
</a>
|
|
28
28
|
</p>
|
|
29
29
|
|
|
@@ -39,7 +39,7 @@ Core agent contributions by **devcorex**.
|
|
|
39
39
|
- **8 languages** — Node.js, Python, Go, Rust, C/C++, PHP, Perl, Bun
|
|
40
40
|
- **5 databases** — PostgreSQL, MariaDB, SQLite, MongoDB, Redis
|
|
41
41
|
- **22 dev tools** — gh, curl, fzf, bat, lsd, jq, tmux, openssh, snyk and more
|
|
42
|
-
- **
|
|
42
|
+
- **13 utility tools** — fconv, notes, treex, qrcode, SuperFile, zork, herdr and more
|
|
43
43
|
- **2 network tools** — dark, dedsec-network
|
|
44
44
|
- **4 deploy CLIs** — Vercel, Railway, Netlify, Supabase
|
|
45
45
|
- **Responsible OSINT** — Robin v2.8 through Tor with a loopback-only web UI
|
|
@@ -54,6 +54,23 @@ Core agent contributions by **devcorex**.
|
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 🌟 Featured: Herdr — terminal AI assistant
|
|
60
|
+
|
|
61
|
+
Karnel now ships **[Herdr](https://herdr.dev)**, a blazing-fast terminal AI assistant CLI, as a first-class utility. Install it with:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
karnel install utils --herdr
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Why it's great:
|
|
68
|
+
- **Checksum-verified** download from the official Herdr release manifest (`https://herdr.dev/latest.json`).
|
|
69
|
+
- **Atomic, safe install** into `$PREFIX/bin/herdr` with a Karnel ownership marker — so `karnel uninstall utils --herdr` is clean and never touches files it didn't manage.
|
|
70
|
+
- Pairs perfectly with the 45+ other AI agents Karnel manages.
|
|
71
|
+
|
|
72
|
+
> Open its docs anytime with `karnel open herdr`.
|
|
73
|
+
|
|
57
74
|
---
|
|
58
75
|
|
|
59
76
|
## Installation
|
|
@@ -61,7 +78,7 @@ Core agent contributions by **devcorex**.
|
|
|
61
78
|
### Via checksummed GitHub release (recommended)
|
|
62
79
|
|
|
63
80
|
```bash
|
|
64
|
-
version=4.17.
|
|
81
|
+
version=4.17.11
|
|
65
82
|
tmpdir=$(mktemp -d) && trap 'rm -rf "$tmpdir"' EXIT
|
|
66
83
|
base="https://github.com/israelmarques1024-dotcom/karnel-termux/releases/download/v$version"
|
|
67
84
|
curl -fsSL "$base/karnel-termux-install.sh" -o "$tmpdir/karnel-termux-install.sh"
|
|
@@ -106,6 +123,7 @@ aliases, or options; use `karnel help` and the CLI reference for the full set.
|
|
|
106
123
|
| `karnel update <module>` | Update modules or karnel |
|
|
107
124
|
| `karnel uninstall <module>` | Remove installed modules |
|
|
108
125
|
| `karnel reinstall <module>` | Reinstall modules |
|
|
126
|
+
| `karnel upgrade` | Upgrade the framework (self-update) |
|
|
109
127
|
| `karnel doctor termux` | Diagnose the Termux environment (30+ sections) |
|
|
110
128
|
| `karnel doctor code` | Detect project ecosystems and run code checks |
|
|
111
129
|
| `karnel doctor robin` | Diagnose Robin, Tor, dependencies, and local UI |
|
|
@@ -152,7 +170,7 @@ aliases, or options; use `karnel help` and the CLI reference for the full set.
|
|
|
152
170
|
karnel install ai --keelcode
|
|
153
171
|
|
|
154
172
|
# Install the SuperFile terminal file manager
|
|
155
|
-
karnel install utils --superfile
|
|
173
|
+
karnel install utils --superfile --herdr
|
|
156
174
|
```
|
|
157
175
|
|
|
158
176
|
Both tools support `update`, `reinstall`, and `uninstall` with the same module and flag.
|
|
@@ -343,7 +361,7 @@ karnel doctor termux --quick # Run essential system/package checks only
|
|
|
343
361
|
karnel doctor termux --fix # Apply queued fixes without group confirmation
|
|
344
362
|
|
|
345
363
|
karnel doctor code # Quick project analysis
|
|
346
|
-
karnel doctor code --standard . # Add security, deps,
|
|
364
|
+
karnel doctor code --standard . # Add security, deps, dead-code and complexity
|
|
347
365
|
karnel doctor code --deep --json . # All 76 definitions as standalone JSON
|
|
348
366
|
karnel doctor code --fix . # Apply fixes classified as safe
|
|
349
367
|
karnel doctor robin # Robin/Tor/dependency diagnostics
|
|
@@ -430,7 +448,7 @@ Microphone -> termux-speech-to-text -> editor (edit) -> clipboard -> AI agent
|
|
|
430
448
|
### Requirements
|
|
431
449
|
|
|
432
450
|
- Termux:API: `pkg install termux-api`
|
|
433
|
-
- App Termux:API: https://
|
|
451
|
+
- App Termux:API: https://israelmarques1024-dotcom.github.io/karnel-termux/termux/api
|
|
434
452
|
- Editor (optional): `karnel install editor`; otherwise use `--raw` or the automatic raw fallback
|
|
435
453
|
|
|
436
454
|
---
|
|
@@ -507,7 +525,7 @@ karnel open ai # Open AI module docs
|
|
|
507
525
|
karnel open db # Open DB module docs
|
|
508
526
|
```
|
|
509
527
|
|
|
510
|
-
Documentation loads from https://
|
|
528
|
+
Documentation loads from https://israelmarques1024-dotcom.github.io/karnel-termux.
|
|
511
529
|
|
|
512
530
|
---
|
|
513
531
|
|
|
@@ -519,7 +537,7 @@ Documentation loads from https://karneltermux.vercel.app.
|
|
|
519
537
|
- [Troubleshooting](docs/troubleshooting/index.md)
|
|
520
538
|
- [Architecture](docs/ARCHITECTURE/index.md)
|
|
521
539
|
- [Documentation changelog](docs/CHANGELOG.md)
|
|
522
|
-
- [Official website](https://
|
|
540
|
+
- [Official website](https://israelmarques1024-dotcom.github.io/karnel-termux)
|
|
523
541
|
|
|
524
542
|
---
|
|
525
543
|
|
|
@@ -574,7 +592,7 @@ karnel/
|
|
|
574
592
|
│ │ ├── ui/ # 4 UI components
|
|
575
593
|
│ │ ├── auto/ # 1 automation tool
|
|
576
594
|
│ │ ├── network/ # 2 network tools
|
|
577
|
-
│ │ ├── utils/ #
|
|
595
|
+
│ │ ├── utils/ # 13 utility tools
|
|
578
596
|
│ │ ├── games/ # 6 games
|
|
579
597
|
│ │ ├── security/ # 30 security tools
|
|
580
598
|
│ │ └── deploy/ # 4 deploy CLIs
|
|
@@ -651,7 +669,7 @@ MIT © Israel Marques
|
|
|
651
669
|
---
|
|
652
670
|
|
|
653
671
|
<p align="center">
|
|
654
|
-
<a href="https://
|
|
672
|
+
<a href="https://israelmarques1024-dotcom.github.io/karnel-termux">
|
|
655
673
|
<img src="https://img.shields.io/badge/Full%20Documentation-0078D4?style=for-the-badge" alt="Documentation">
|
|
656
674
|
</a>
|
|
657
675
|
<a href="https://www.youtube.com/@capideb">
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Architecture
|
|
3
|
+
permalink: /ARCHITECTURE/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
1
7
|
# Karnel Architecture
|
|
2
8
|
|
|
3
9
|
## Project Structure
|
|
@@ -39,7 +45,7 @@ karnel-termux/
|
|
|
39
45
|
│ │ ├── deploy/ # 4 deploy CLIs
|
|
40
46
|
│ │ ├── games/ # 6 games
|
|
41
47
|
│ │ ├── network/ # 2 network tools (dark, dedsec-network)
|
|
42
|
-
│ │ ├── utils/ #
|
|
48
|
+
│ │ ├── utils/ # 13 utility tools (fconv, notes, zork, SuperFile, herdr, etc.)
|
|
43
49
|
│ │ ├── security/ # 30 security tools
|
|
44
50
|
│ │ ├── voice/ # Speech-to-agent via Termux:API
|
|
45
51
|
│ │ ├── plugins/ # Built-in plugin manager
|
package/docs/CHANGELOG.md
CHANGED
|
@@ -1,10 +1,62 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Documentation Changelog
|
|
3
3
|
permalink: /CHANGELOG/
|
|
4
|
+
layout: base
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
# Documentation Changelog
|
|
7
8
|
|
|
9
|
+
## 4.17.13
|
|
10
|
+
|
|
11
|
+
- Fixed the shell completion catalog (`scripts/completion.bash` / `completion.zsh`) to include the `herdr` utils tool, satisfying the `completion-catalog` CI gate.
|
|
12
|
+
|
|
13
|
+
## 4.17.12
|
|
14
|
+
|
|
15
|
+
- Generated real per-module documentation pages under `/karnel/<module>/` (all 17 modules: ai, auto, db, deploy, dev, editor, games, lang, network, npm, osint, plugin, security, shell, ui, utils, voice).
|
|
16
|
+
- `karnel open <module>` now opens the in-site page (`/karnel/<module>/`) instead of the GitHub source; added a dedicated `herdr` open target that opens the utils page.
|
|
17
|
+
- Featured **Herdr** prominently in the README and on the site landing page, with a `karnel install utils --herdr` callout.
|
|
18
|
+
- Added `karnel/tools/utils/herdr/README.md` so `karnel show utils --herdr` renders proper documentation.
|
|
19
|
+
- Site/CLI audit: fixed the stale "12 scripts" utils summary in the CLI reference (now lists all 13 tools including Herdr).
|
|
20
|
+
|
|
21
|
+
## 4.17.11
|
|
22
|
+
|
|
23
|
+
- Added the **Herdr** CLI to the `utils` module (`karnel install utils --herdr`), with checksum-verified download, atomic install, and Karnel ownership markers.
|
|
24
|
+
- Critical runtime fixes:
|
|
25
|
+
- `cursor-cli`, `hermes-agent` and the `doctor` psutil patch now extract archives with the guarded `safe_extract_tar` (path-traversal/symlink protection).
|
|
26
|
+
- `pg schedule` now exports `PATH`/`PREFIX` in the cron job and logs failures instead of discarding output.
|
|
27
|
+
- `pg restore` uses `--single-transaction` and surfaces errors instead of silently retrying.
|
|
28
|
+
- `doctor --fix` no longer auto-applies destructive fixes (install-class, cache wipes, mass symlink deletion) without explicit confirmation; non-interactive sessions skip them (fail-closed).
|
|
29
|
+
- `doctor code --fix` now snapshots each rewritten file to `<file>.karnel-bak` before applying in-place formatters.
|
|
30
|
+
- `_fix_broken_symlinks` only removes broken symlinks that point into Karnel-managed paths.
|
|
31
|
+
- `karnel upgrade` no longer triggers a concurrent update check.
|
|
32
|
+
- `shell.sh` temp directory falls back to `KARNEL_CACHE` instead of `/tmp`.
|
|
33
|
+
- Website/documentation overhaul: `karnel open` now resolves to real GitHub source URLs (no more 404s), canonical site URL unified to GitHub Pages, utility-tool count corrected to 13 (Herdr added), cloud-backup docs corrected to rclone, added `karnel upgrade` to the command table, and added favicon/SEO meta + Troubleshooting nav.
|
|
34
|
+
|
|
35
|
+
## 4.17.10
|
|
36
|
+
|
|
37
|
+
- Round 10 security/correctness hardening (23 distinct fixes):
|
|
38
|
+
- **Termux `/tmp` fallbacks eliminated** across host-side code
|
|
39
|
+
(`update.sh`, `brain.sh`, `version.sh`, `log.sh`, `agent_actions.sh`,
|
|
40
|
+
`doctor/code_langs.sh`, `supabase`, and the `security/*` tools amass,
|
|
41
|
+
subfinder, ffuf, gobuster, burpsuite, zap) — now use `KARNEL_CACHE`.
|
|
42
|
+
- **`karnel show <module>`** now rejects invalid module names
|
|
43
|
+
(`/`, `..`, `~`), closing a path-traversal / information-disclosure bug.
|
|
44
|
+
- **Agent PLAN (read-only) mode** hardened: blocks `sed`/`awk`/`perl`/
|
|
45
|
+
`xargs`/`make`/`env`/`nohup`/`setsid`, `sed`/`perl -i`, editors,
|
|
46
|
+
`git apply`/`worktree`/`read-tree`/`update-index`, and now also catches
|
|
47
|
+
redirections without a preceding space (`echo x>file`).
|
|
48
|
+
- **Plugin supply chain** fail-closed: installs now require a manifest
|
|
49
|
+
checksum (was silently skipped), and registry installs pin to a committed
|
|
50
|
+
SHA when provided.
|
|
51
|
+
- **`karnel pg backup --schedule`** no longer swallows `crontab` failures
|
|
52
|
+
and uses the escaped DB name to avoid duplicate cron jobs.
|
|
53
|
+
- **Reinstall** now proceeds to install when the uninstall step reports
|
|
54
|
+
"already uninstalled" (rc 2) instead of aborting.
|
|
55
|
+
- **Archive extraction hardened**: `cline`, `goose`, `kiro` AI installers
|
|
56
|
+
and `zork` now use the safe extractors; `zork` also drops literal `/tmp`.
|
|
57
|
+
- Site fully overhauled (navigation, dark mode, GitHub Pages URLs, Liquid
|
|
58
|
+
fixes, consistent front matter).
|
|
59
|
+
|
|
8
60
|
## 4.17.9
|
|
9
61
|
|
|
10
62
|
- Hardened installer and runtime security across the toolkit:
|
package/docs/_config.yml
CHANGED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: default
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<link rel="icon" href="{{ '/assets/images/karnel-logo.png' | relative_url }}">
|
|
6
|
+
<meta name="description" content="Modular Dev Environment for Termux — install languages, databases, AI agents, editors, and more with one command.">
|
|
7
|
+
<meta property="og:title" content="Karnel Termux">
|
|
8
|
+
<meta property="og:description" content="Modular Dev Environment for Termux.">
|
|
9
|
+
<meta property="og:type" content="website">
|
|
10
|
+
|
|
11
|
+
<nav class="site-nav" aria-label="Documentation">
|
|
12
|
+
<a href="{{ '/' | relative_url }}">Docs</a>
|
|
13
|
+
<a href="{{ '/cli/' | relative_url }}">CLI</a>
|
|
14
|
+
<a href="{{ '/doctor/' | relative_url }}">Doctor</a>
|
|
15
|
+
<a href="{{ '/troubleshooting/' | relative_url }}">Troubleshooting</a>
|
|
16
|
+
<a href="{{ '/ARCHITECTURE/' | relative_url }}">Architecture</a>
|
|
17
|
+
<a href="{{ '/CHANGELOG/' | relative_url }}">Changelog</a>
|
|
18
|
+
<a href="https://israelmarques1024-dotcom.github.io/karnel-termux/">Live Site</a>
|
|
19
|
+
</nav>
|
|
20
|
+
|
|
21
|
+
{{ content }}
|
|
@@ -246,3 +246,37 @@ body {
|
|
|
246
246
|
border-top: 1px solid #e1e4e8;
|
|
247
247
|
padding-top: 1rem;
|
|
248
248
|
}
|
|
249
|
+
|
|
250
|
+
/* Top navigation bar (injected by _layouts/base.html) */
|
|
251
|
+
.site-nav {
|
|
252
|
+
display: flex;
|
|
253
|
+
flex-wrap: wrap;
|
|
254
|
+
gap: 0.4rem 1.1rem;
|
|
255
|
+
align-items: center;
|
|
256
|
+
padding: 0.7rem 1rem;
|
|
257
|
+
margin-bottom: 1.75rem;
|
|
258
|
+
background: #f3f5f8;
|
|
259
|
+
border: 1px solid #d0d7de;
|
|
260
|
+
border-radius: 10px;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
.site-nav a {
|
|
264
|
+
color: #0078d4;
|
|
265
|
+
text-decoration: none;
|
|
266
|
+
font-weight: 600;
|
|
267
|
+
font-size: 0.92rem;
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
.site-nav a:hover {
|
|
271
|
+
text-decoration: underline;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
@media (prefers-color-scheme: dark) {
|
|
275
|
+
.site-nav {
|
|
276
|
+
background: var(--karnel-panel);
|
|
277
|
+
border-color: var(--karnel-border);
|
|
278
|
+
}
|
|
279
|
+
.site-nav a {
|
|
280
|
+
color: var(--karnel-accent);
|
|
281
|
+
}
|
|
282
|
+
}
|
package/docs/cli/index.md
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CLI Commands
|
|
3
|
+
permalink: /cli/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
1
7
|
# Karnel CLI Reference
|
|
2
8
|
|
|
3
9
|
```bash
|
|
@@ -33,7 +39,7 @@ karnel install <module> --tool1 --tool2 # Install specific tools only
|
|
|
33
39
|
| `deploy` | Vercel, Railway, Netlify, Supabase CLIs |
|
|
34
40
|
| `games` | Buzz, CTF God, Detective, Tamagotchi, Arcade, Pet Friends |
|
|
35
41
|
| `network` | Dark Web OSINT, DedSec Network Toolkit |
|
|
36
|
-
| `utils` | fconv, filecheck, notes,
|
|
42
|
+
| `utils` | fconv, filecheck, websites, notes, treex, passman, applaunch, splash, httptmux, zork, qrcode, superfile, herdr (13 scripts) |
|
|
37
43
|
| `osint` | Robin v2.8 — dark web OSINT via Tor + LLM |
|
|
38
44
|
| `voice` | Speech-to-agent via Termux:API |
|
|
39
45
|
| `security`| Nmap, Hydra, SQLMap, Metasploit, and 26 other tools |
|
|
@@ -55,7 +61,7 @@ karnel install <module> --tool1 --tool2 # Install specific tools only
|
|
|
55
61
|
| `deploy` | `--vercel`, `--railway`, `--netlify`, `--supabase` |
|
|
56
62
|
| `games` | `--buzz`, `--ctfgod`, `--detective`, `--pet-friends`, `--tamagotchi`, `--arcade` |
|
|
57
63
|
| `network` | `--dark`, `--dedsec-network` |
|
|
58
|
-
| `utils` | `--fconv`, `--filecheck`, `--websites`, `--notes`, `--treex`, `--passman`, `--applaunch`, `--splash`, `--httptmux`, `--zork`, `--qrcode`, `--superfile` |
|
|
64
|
+
| `utils` | `--fconv`, `--filecheck`, `--websites`, `--notes`, `--treex`, `--passman`, `--applaunch`, `--splash`, `--httptmux`, `--zork`, `--qrcode`, `--superfile`, `--herdr` |
|
|
59
65
|
| `security`| Run `karnel list security` for the 30 supported tool flags |
|
|
60
66
|
|
|
61
67
|
```bash
|
|
@@ -146,7 +152,7 @@ binary/command name, and current install status.
|
|
|
146
152
|
| `deploy` | 4 deploy CLIs |
|
|
147
153
|
| `games` | 6 games |
|
|
148
154
|
| `network` | 2 network tools |
|
|
149
|
-
| `utils` |
|
|
155
|
+
| `utils` | 13 utility scripts |
|
|
150
156
|
| `osint` | Robin OSINT |
|
|
151
157
|
| `voice` | Voice commands |
|
|
152
158
|
| `security`| 30 security tools |
|
|
@@ -190,7 +196,7 @@ karnel open <target>
|
|
|
190
196
|
```
|
|
191
197
|
|
|
192
198
|
Opens the official documentation page for a module using
|
|
193
|
-
`termux-open-url`. Base URL: `https://
|
|
199
|
+
`termux-open-url`. Base URL: `https://israelmarques1024-dotcom.github.io/karnel-termux`
|
|
194
200
|
|
|
195
201
|
| Target | Opens |
|
|
196
202
|
|------------------|-------|
|
|
@@ -282,7 +288,7 @@ Karnel, AI commands, shell config, processes, networking.
|
|
|
282
288
|
|
|
283
289
|
```bash
|
|
284
290
|
karnel doctor code # Quick registry set (default)
|
|
285
|
-
karnel doctor code --standard /path/to/project # + security, deps,
|
|
291
|
+
karnel doctor code --standard /path/to/project # + security, deps, dead-code
|
|
286
292
|
karnel doctor code --deep --json /path/to/project # All 76 definitions
|
|
287
293
|
karnel doctor code --fix /path/to/project # Apply safe fixes
|
|
288
294
|
```
|
|
@@ -760,7 +766,7 @@ contain credentials. Protect local and cloud copies as sensitive plaintext data.
|
|
|
760
766
|
|
|
761
767
|
| Flag | Description |
|
|
762
768
|
|------|-------------|
|
|
763
|
-
| `--cloud` |
|
|
769
|
+
| `--cloud` | Upload to a configured rclone remote named `karnel` (e.g. Google Drive); archives are unencrypted at rest, so the `KARNEL_ALLOW_PLAINTEXT_CLOUD_BACKUP=1` acknowledgement is required |
|
|
764
770
|
| `snapshot <name>` | Create a timestamped named snapshot using the same contents and secret filter as a full backup; names accept 1-64 letters, numbers, dots, underscores, or hyphens |
|
|
765
771
|
| `list` / `ls` | List full backups and snapshots |
|
|
766
772
|
| `info` / `show [file]` | Show a backup's contents (latest if omitted) |
|
|
@@ -811,7 +817,7 @@ Karnel if `apt-get` changes package state before returning an error.
|
|
|
811
817
|
| Argument | Description |
|
|
812
818
|
|----------|-------------|
|
|
813
819
|
| `<file>` | Path to a specific backup file |
|
|
814
|
-
| `--cloud` |
|
|
820
|
+
| `--cloud` | Restore from the rclone remote named `karnel`; a remote can replace both archive and checksum, so `KARNEL_ALLOW_UNAUTHENTICATED_CLOUD_RESTORE=1` is required to trust it |
|
|
815
821
|
| `--list`, `-l` | List available full backups and snapshots |
|
|
816
822
|
| `--help`, `-h` | Show help |
|
|
817
823
|
|
package/docs/doctor/index.md
CHANGED
package/docs/index.md
CHANGED
|
@@ -1,36 +1,37 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
title: Karnel Termux Documentation
|
|
3
|
+
permalink: /
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
2
6
|
|
|
3
7
|
<img class="karnel-logo" src="{{ '/assets/images/karnel-logo.png' | relative_url }}" alt="Karnel Termux">
|
|
4
8
|
|
|
5
9
|
> Modular Dev Environment for Termux — install languages, databases, AI agents, editors, and more with one command
|
|
6
10
|
|
|
7
|
-
Navigate the docs:
|
|
8
|
-
|
|
9
|
-
<ul class="karnel-nav">
|
|
10
|
-
<li><a href="./cli/">CLI Commands</a></li>
|
|
11
|
-
<li><a href="./doctor/">Doctor System</a></li>
|
|
12
|
-
<li><a href="./troubleshooting/">Troubleshooting</a></li>
|
|
13
|
-
<li><a href="./ARCHITECTURE/">Architecture</a></li>
|
|
14
|
-
<li><a href="./CHANGELOG/">Changelog</a></li>
|
|
15
|
-
<li><a href="https://israelmarques1024-dotcom.github.io/karnel-termux/">Live Site</a></li>
|
|
16
|
-
</ul>
|
|
17
|
-
|
|
18
11
|
## What is Karnel?
|
|
19
12
|
|
|
20
13
|
Karnel Termux transforms your Android device into a complete development workstation.
|
|
21
14
|
With a single CLI (`karnel`), you can install and manage 45 AI tools, 3 editors,
|
|
22
15
|
8 languages, 5 databases, 22 dev tools, 11 npm packages, 10 shell plugins,
|
|
23
|
-
4 UI components, 4 deploy CLIs, 6 games, 2 network tools,
|
|
16
|
+
4 UI components, 4 deploy CLIs, 6 games, 2 network tools, 13 utility tools,
|
|
24
17
|
30 security tools, 1 automation tool, responsible OSINT, a second brain,
|
|
25
18
|
voice commands, and reviewed plugins — all from modules: `ai`, `auto`, `db`,
|
|
26
19
|
`deploy`, `dev`, `editor`, `games`, `lang`, `network`, `npm`, `osint`,
|
|
27
20
|
`security`, `shell`, `ui`, `utils`, `voice`, `plugin`.
|
|
28
21
|
|
|
22
|
+
## 🌟 Featured: Herdr
|
|
23
|
+
|
|
24
|
+
Karnel now ships **[Herdr](https://herdr.dev)**, a terminal AI assistant CLI, as a managed utility.
|
|
25
|
+
Install it with `karnel install utils --herdr` — the binary is checksum-verified from the official
|
|
26
|
+
release manifest and tracked with Karnel ownership markers, so `karnel uninstall utils --herdr` is clean.
|
|
27
|
+
Open its docs with `karnel open herdr`.
|
|
28
|
+
|
|
29
29
|
## Sections
|
|
30
30
|
|
|
31
31
|
<div class="karnel-links">
|
|
32
32
|
<a href="./cli/">CLI Commands — full reference for every <code>karnel</code> subcommand</a>
|
|
33
33
|
<a href="./doctor/">Doctor System — environment checks and the code-analysis engine</a>
|
|
34
|
+
<a href="./troubleshooting/">Troubleshooting — common issues and fixes</a>
|
|
34
35
|
<a href="https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/karnel/tools/osint/robin/README.md">Robin OSINT — responsible use, lifecycle, data locations</a>
|
|
35
36
|
<a href="https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/karnel/tools/network/dark/README.md">Network Tools — dark, dedsec-network</a>
|
|
36
37
|
<a href="https://github.com/israelmarques1024-dotcom/karnel-termux/blob/main/karnel/tools/ai/keelcode/README.md">KeelCode — hosted coding-agent CLI</a>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Ai module
|
|
3
|
+
permalink: /karnel/ai/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Ai module
|
|
8
|
+
|
|
9
|
+
AI coding agents and assistants (Claude Code, Codex, Cline, Goose, and many more).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `ai` | `--qwen-code`, `--gemini-cli`, `--claude-code`, `--mistral-vibe`, `--openclaude`, `--openclaw`, `--ollama`, `--codex`, `--opencode`, `--mimocode`, `--engram`, `--codegraph`, `--pi`, `--antigravity-cli`, `--minimax-cli`, `--gentle-ai`, `--gga`, `--hermes-agent`, `--kimi-code`, `--command-code`, `--codebuff`, `--freebuff`, `--kilocode-cli`, `--kiro`, `--crush`, `--cline`, `--odysseus`, `--kimchi-code`, `--omni-route`, `--ctx7`, `--openspec`, `--supercode-cli`, `--puter`, `--keelcode`, `--copilot-termux`, `--qoder`, `--ampcode`, `--cursor-cli`, `--oh-my-pi`, `--goose`, `--droid`, `--cactus`, `--cactus-needle`, `--walkie`, `--hugging-face` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#ai) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/ai.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Auto module
|
|
3
|
+
permalink: /karnel/auto/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Auto module
|
|
8
|
+
|
|
9
|
+
Automation and workflow tooling (n8n).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `auto` | `--n8n` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#auto) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/auto.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Db module
|
|
3
|
+
permalink: /karnel/db/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Db module
|
|
8
|
+
|
|
9
|
+
Databases such as PostgreSQL, MongoDB, Redis and companions.
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `db` | `--postgresql`, `--mariadb`, `--sqlite`, `--mongodb`, `--redis` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#db) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/db.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Deploy module
|
|
3
|
+
permalink: /karnel/deploy/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Deploy module
|
|
8
|
+
|
|
9
|
+
Deploy CLIs (Railway, Netlify, Vercel, Supabase).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `deploy` | `--vercel`, `--railway`, `--netlify`, `--supabase` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#deploy) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/deploy.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Dev module
|
|
3
|
+
permalink: /karnel/dev/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Dev module
|
|
8
|
+
|
|
9
|
+
General development utilities (fzf, bat, make, proot-distro, tmux, and more).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `dev` | `--gh`, `--wget`, `--curl`, `--lsd`, `--bat`, `--proot`, `--ncurses`, `--tmate`, `--openssh`, `--tmux`, `--cloudflared`, `--translate`, `--html2text`, `--jq`, `--bc`, `--tree`, `--fzf`, `--imagemagick`, `--shfmt`, `--make`, `--udocker`, `--snyk` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#dev) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/dev.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Editor module
|
|
3
|
+
permalink: /karnel/editor/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Editor module
|
|
8
|
+
|
|
9
|
+
Terminal and browser-based editors (code-server, Neovim, and more).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `editor` | `--code-server`, `--neovim`, `--nvchad` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#editor) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/editor.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Games module
|
|
3
|
+
permalink: /karnel/games/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Games module
|
|
8
|
+
|
|
9
|
+
Terminal games to relax between sessions.
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `games` | `--buzz`, `--ctfgod`, `--detective`, `--pet-friends`, `--tamagotchi`, `--arcade` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#games) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/games.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Lang module
|
|
3
|
+
permalink: /karnel/lang/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Lang module
|
|
8
|
+
|
|
9
|
+
Programming-language runtimes (Python, Node.js, Rust, Go, and more).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `lang` | `--bun`, `--nodejs`, `--python`, `--perl`, `--php`, `--rust`, `--clang`, `--golang` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#lang) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/lang.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Network module
|
|
3
|
+
permalink: /karnel/network/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Network module
|
|
8
|
+
|
|
9
|
+
Network utilities (dark, dedsec-network).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `network` | `--dark`, `--dedsec-network` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#network) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/network.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Npm module
|
|
3
|
+
permalink: /karnel/npm/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Npm module
|
|
8
|
+
|
|
9
|
+
Node.js packages and JavaScript tooling.
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `npm` | `--typescript`, `--nestjs`, `--prettier`, `--live-server`, `--localtunnel`, `--vercel`, `--markserv`, `--psqlformat`, `--ncu`, `--ngrok`, `--turbopack` |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#npm) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/npm.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Osint module
|
|
3
|
+
permalink: /karnel/osint/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Osint module
|
|
8
|
+
|
|
9
|
+
OSINT tooling, centered on Robin.
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `osint` | Robin OSINT |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#osint) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/osint.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Plugin module
|
|
3
|
+
permalink: /karnel/plugin/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Plugin module
|
|
8
|
+
|
|
9
|
+
The plugin system and manager.
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `plugin` | Plugin system |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#plugin) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/plugin.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Security module
|
|
3
|
+
permalink: /karnel/security/
|
|
4
|
+
layout: base
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Security module
|
|
8
|
+
|
|
9
|
+
Security and pentest tooling (30+ tools).
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
| `security` | Security tools |
|
|
13
|
+
|
|
14
|
+
See the [CLI reference]({ '/cli/' | relative_url }#security) for the full command list, or the
|
|
15
|
+
[source on GitHub](https://github.com/israelmarques1024-dotcom/karnel-termux/tree/main/karnel/modules/security.sh).
|
|
16
|
+
|
|
17
|
+
[← Back to docs]({ '/' | relative_url })
|