@@ -17,14 +17,20 @@ A minimalist terminal chat server with Vim-style interface over SSH.
1717
1818### Installation
1919
20- ** One-liner :**
20+ ** Pinned release installer :**
2121``` sh
22- curl -sSL https://raw.githubusercontent.com/m1ngsama/TNT/main /install.sh | sh
22+ curl -sSL https://raw.githubusercontent.com/m1ngsama/TNT/v1.1.0 /install.sh | VERSION=v1.1.0 sh
2323```
2424The installer verifies downloaded release binaries against ` checksums.txt `
2525before installing them. Older releases may provide only ` tnt ` ; newer releases
2626also install ` tntctl ` .
2727
28+ For convenience during testing, the moving ` main ` installer is also available:
29+
30+ ``` sh
31+ curl -sSL https://raw.githubusercontent.com/m1ngsama/TNT/main/install.sh | sh
32+ ```
33+
2834** From source:**
2935``` sh
3036git clone https://github.com/m1ngsama/TNT.git
@@ -36,6 +42,18 @@ sudo make install
3642** Binary releases:**
3743https://github.com/m1ngsama/TNT/releases
3844
45+ ** Interactive setup guide:**
46+
47+ After installing the binary, operators can generate a reviewable environment
48+ file and choose a module profile with the terminal setup wizard:
49+
50+ ``` sh
51+ scripts/install_wizard.sh --output tnt.env
52+ ```
53+
54+ The wizard does not restart services or install modules. Review the generated
55+ file, then install it manually as your systemd environment file.
56+
3957### Running
4058
4159``` sh
@@ -422,6 +440,33 @@ replace placeholder checksums, and run:
422440SOURCE_TARBALL=dist/tnt-chat-vX.Y.Z-source.tar.gz make package-publish-check
423441```
424442
443+ ## Module Development
444+
445+ TNT modules are external processes that speak the ` tnt.module.v1 ` JSON Lines
446+ protocol over stdin/stdout. TNT core stays minimal, Unix-like, text-first, and
447+ reliable; modules are the optional layer for richer modern-terminal interaction,
448+ visual presentation, workflow automation, and future community features.
449+
450+ The core server owns the protocol contract and the runtime supervisor;
451+ community module examples and module packages live in the public companion
452+ repository:
453+
454+ https://github.com/m1ngsama/tnt-modules
455+
456+ Before enabling a third-party module, check its manifest and handshake:
457+
458+ ``` sh
459+ scripts/module_check.sh /path/to/module
460+ ```
461+
462+ Enable reviewed modules explicitly:
463+
464+ ``` sh
465+ TNT_MODULE_PATHS=/opt/tnt-modules/echo-module:/opt/tnt-modules/other-module tnt
466+ ```
467+
468+ Unset ` TNT_MODULE_PATHS ` and restart TNT to return to the plain core server.
469+
425470## Files
426471
427472```
@@ -432,11 +477,11 @@ tnt.service - systemd service unit
432477```
433478
434479The persisted chat-history format is documented in
435- [ docs/MESSAGE_LOG.md] ( docs/MESSAGE_LOG.md ) . Experimental community modules
436- should follow the external-process protocol in
437- [ docs/MODULE_PROTOCOL.md ] ( docs/MODULE_PROTOCOL.md ) . Module-generated content
438- must always include a plain-text fallback so TNT can keep working on basic
439- terminal clients and preserve the stable ` messages.log ` v1 history contract.
480+ [ docs/MESSAGE_LOG.md] ( docs/MESSAGE_LOG.md ) . The core module protocol is
481+ documented in [ docs/MODULE_PROTOCOL.md ] ( docs/MODULE_PROTOCOL.md ) .
482+ Module-generated content must always include a plain-text fallback so TNT can
483+ keep working on basic terminal clients and preserve the stable ` messages.log `
484+ v1 history contract.
440485
441486### MOTD (Message of the Day)
442487
@@ -457,6 +502,7 @@ Delete `motd.txt` to disable the MOTD.
457502- [ Development Guide] ( https://github.com/m1ngsama/TNT/wiki/Development-Guide ) - Complete development manual
458503- [ Quick Setup] ( docs/EASY_SETUP.md ) - 5-minute deployment guide
459504- [ Roadmap] ( docs/ROADMAP.md ) - Long-term Unix/GNU direction and next stages
505+ - [ Installation Lifecycle] ( docs/INSTALL_LIFECYCLE.md ) - Setup wizard, module selection, and rollback model
460506- [ Interface Contract] ( docs/INTERFACE.md ) - Scriptable commands, exit statuses, and JSON fields
461507- [ Module Protocol] ( docs/MODULE_PROTOCOL.md ) - External-process module contract
462508- [ Security Reference] ( docs/SECURITY_QUICKREF.md ) - Security config quick reference
0 commit comments