@quangnv13/nonstop 1.0.0 → 1.0.1

package/README.md

@@ -14,6 +14,23 @@
 
 ---
 
+## 📖 Table of Contents
+
+* [🌟 Key Features](#-key-features)
+* [⚙️ Architecture & Data Flow](#️-architecture--data-flow)
+* [🚀 Quick Start](#-quick-start)
+  * [1. Installation](#1-installation)
+  * [2. Creating a Telegram Bot](#2-creating-a-telegram-bot)
+  * [3. Run and Setup](#3-run-and-setup)
+* [🕹️ Usage Guide](#️-usage-guide)
+  * [1. Local TUI Control Center](#1-local-tui-control-center)
+  * [2. Telegram Bot Interaction](#2-telegram-bot-interaction)
+* [🎛️ Configuration](#️-configuration)
+* [🛡️ Security Best Practices](#️-security-best-practices)
+* [📄 License](#-license)
+
+---
+
 ## 🌟 Key Features
 
 * **💻 Immersive TUI Control Center** — Manage runtime processes, inspect logs, register workspaces, and edit configuration directly from a command-line interface.
@@ -45,10 +62,43 @@ graph TD
 
 ---
 
+## 🚀 Quick Start
+
+### 1. Installation
+Install the package globally using npm:
+```bash
+npm install -g @quangnv13/nonstop
+```
+
+### 2. Creating a Telegram Bot
+To run `nonstop`, you must obtain a Telegram Bot token. Here is how to create one using `@BotFather`:
+
+1. Open Telegram and search for **@BotFather** (ensure it has the verified blue checkmark).
+2. Start a chat and click **Start** (or send the `/start` command).
+3. Send the `/newbot` command to initiate the bot creation process.
+4. Choose a friendly name for your bot (e.g., `My Nonstop Controller`).
+5. Choose a unique username for your bot, which must end in `bot` (e.g., `my_nonstop_bot`).
+6. Once created, `@BotFather` will reply with your **HTTP API Access Token** (e.g., `123456789:ABCdefGhIJKlmNoPQRsTUVwxyZ`). Copy this token. Keep it private!
+
+### 3. Run and Setup
+Navigate to the directory where you want to store your configuration and run:
+```bash
+nonstop
+```
+> [!NOTE]
+> On the first launch, if your `.env` configuration file is missing, `nonstop` will automatically trigger a **Setup Wizard** in your terminal to configure:
+> * **Telegram Bot Token**: The token you copied from BotFather.
+> * **Allowed Admin Username**: Your Telegram username (starting with `@`) to prevent unauthorized access.
+> * **Client Name**: A name to identify this server.
+> * **Language**: Choose between English (`en`) and Vietnamese (`vi`).
+> * **Startup Mode**: Choose whether it runs on system boot.
+
+---
+
 ## 🕹️ Usage Guide
 
 ### 1. Local TUI Control Center
-Run `npm start` (or `npm run dev`) to open the terminal management dashboard. From here, you can:
+Simply run `nonstop` in your terminal to open the management dashboard. From here, you can:
 * **Start / Stop** the background bot runtime.
 * **Configure Workspaces**: Manage directories where terminal sessions can be started.
 * **Autostart Settings**: Set up the application to run automatically on system boot.
@@ -75,7 +125,7 @@ Once the bot runtime is active, you can interact with it via the following Teleg
    * **▲ Up / ▼ Down** — Navigate command history.
 
 #### **📂 Directory Workspaces**
-* Select **📁 Workspaces** from the main menu to view the folders configured in `data/workspaces.json`.
+* Select **📁 Workspaces** from the main menu to view configured folders.
 * Selecting a workspace sets it as the working directory for your next PTY session.
 
 #### **⚙️ Dynamic Configuration**
@@ -85,61 +135,9 @@ Once the bot runtime is active, you can interact with it via the following Teleg
 
 ---
 
-## 🛠️ Quick Start
-
-### 1. Prerequisites
-Ensure you have [Node.js](https://nodejs.org/) (v18+) and `npm` installed.
-
-### 2. Installation
-Clone the repository and install the dependencies:
-```bash
-git clone https://github.com/quangnv13/nonstop.git
-cd nonstop
-npm install
-```
-
-### 3. Build the Application
-Compile TypeScript to JavaScript production files:
-```bash
-npm run build
-```
-
-### 4. Run `nonstop`
-Launch the interactive terminal-based Control Center:
-```bash
-npm start
-```
-> [!NOTE]
-> On the first launch, if your `.env` configuration file is missing, `nonstop` will automatically trigger a **Setup Wizard** to configure your Telegram bot token, allowed admin username, client name, language, and startup settings.
-
-For development mode (with hot-reload):
-```bash
-npm run dev
-```
-
----
-
-## 📁 Repository Layout
-
-```text
-nonstop/
-├── data/               # Persistent storage (logs, workspaces.json, last-chat-id)
-├── src/                # TypeScript source files
-│   ├── bot.ts          # Telegram bot handlers & callback commands
-│   ├── config.ts       # Config parsers, disk storage, and env bindings
-│   ├── runtime.ts      # Shell session controls & PTY managers
-│   ├── ui.ts           # TUI Control Center console interface
-│   └── index.ts        # App bootstrapper
-├── dist/               # Compiled JavaScript files
-├── .env                # Runtime environment file (git-ignored)
-└── package.json        # Node manifest & scripts
-```
-
----
-
 ## 🎛️ Configuration
 
-Configuration is managed via `.env` at the root of the project. You can copy the template from [`.env.example`](.env.example):
+Configuration is managed via `.env` in the folder where you run the CLI. A template is generated automatically as `.env.example`:
 
 ```ini
 TELEGRAM_BOT_TOKEN=your_telegram_bot_token

package/README.vi.md

@@ -14,6 +14,23 @@
 
 ---
 
+## 📖 Mục Lục
+
+* [🌟 Tính Năng Nổi Bật](#-tính-năng-nổi-bật)
+* [⚙️ Kiến Trúc & Luồng Dữ Liệu](#️-kiến-trúc--luồng-dữ-liệu)
+* [🚀 Hướng Dẫn Nhanh](#-hướng-dẫn-nhanh)
+  * [1. Cài Đặt](#1-cài-đặt)
+  * [2. Tạo Bot Telegram](#2-tạo-bot-telegram)
+  * [3. Khởi Chạy và Thiết Lập](#3-khởi-chạy-và-thiết-lập)
+* [🕹️ Hướng Dẫn Sử Dụng](#️-hướng-dẫn-sử-dụng)
+  * [1. Trung Tâm Điều Khiển TUI Cục Bộ](#1-trung-tâm-điều-khển-tui-cục-bộ)
+  * [2. Tương Tác Qua Telegram Bot](#2-tương-tác-qua-telegram-bot)
+* [🎛️ Cấu Hình Ban Đầu](#️-cấu-hình-ban-đầu)
+* [🛡️ Khuyến Nghị Bảo Mật](#️-khuyến-nghị-bảo-mật)
+* [📄 Bản Quyền](#-bản-quyền)
+
+---
+
 ## 🌟 Tính Năng Nổi Bật
 
 * **💻 Trung Tâm Điều Khiển TUI Trực Quan** — Quản lý các tiến trình runtime, kiểm tra nhật ký (logs), đăng ký thư mục làm việc và sửa đổi cấu hình trực tiếp từ giao diện terminal.
@@ -45,10 +62,43 @@ graph TD
 
 ---
 
+## 🚀 Hướng Dẫn Nhanh
+
+### 1. Cài Đặt
+Cài đặt package toàn cục (globally) bằng npm:
+```bash
+npm install -g @quangnv13/nonstop
+```
+
+### 2. Tạo Bot Telegram
+Để chạy `nonstop`, bạn cần chuẩn bị một token của bot Telegram. Dưới đây là hướng dẫn tạo bot qua `@BotFather`:
+
+1. Mở ứng dụng Telegram, tìm kiếm **@BotFather** (chú ý chọn tài khoản có dấu tích xanh xác thực).
+2. Nhấn **Start** (hoặc gửi lệnh `/start`).
+3. Gửi lệnh `/newbot` để bắt đầu quy trình tạo bot mới.
+4. Nhập tên hiển thị cho bot của bạn (ví dụ: `My Nonstop Controller`).
+5. Nhập tên người dùng (username) duy nhất cho bot, tên này bắt buộc phải kết thúc bằng chữ `bot` (ví dụ: `my_nonstop_bot`).
+6. Sau khi hoàn thành, `@BotFather` sẽ gửi lại cho bạn một mã **HTTP API Access Token** (dạng như: `123456789:ABCdefGhIJKlmNoPQRsTUVwxyZ`). Copy lại mã token này và giữ bí mật.
+
+### 3. Khởi Chạy và Thiết Lập
+Di chuyển tới thư mục bạn muốn lưu cấu hình nonstop và chạy lệnh:
+```bash
+nonstop
+```
+> [!NOTE]
+> Trong lần chạy đầu tiên, nếu tệp `.env` chưa tồn tại trong thư mục, `nonstop` sẽ tự động hiển thị **Trình hướng dẫn thiết lập (Setup Wizard)** trực tiếp trên terminal của bạn để giúp bạn điền:
+> * **Telegram Bot Token**: Token bạn vừa lấy từ BotFather.
+> * **Allowed Admin Username**: Tên người dùng Telegram của bạn (bắt đầu bằng `@`) để ngăn chặn các truy cập trái phép.
+> * **Client Name**: Tên định danh cho server này.
+> * **Language**: Chọn ngôn ngữ hiển thị (tiếng Anh `en` hoặc tiếng Việt `vi`).
+> * **Startup Mode**: Cấu hình tự khởi động cùng hệ điều hành.
+
+---
+
 ## 🕹️ Hướng Dẫn Sử Dụng
 
 ### 1. Trung Tâm Điều Khiển TUI Cục Bộ
-Chạy lệnh `npm start` (hoặc `npm run dev`) để mở giao diện quản lý trên terminal của bạn. Tại đây, bạn có thể:
+Chỉ cần chạy lệnh `nonstop` trên terminal của bạn để mở giao diện bảng điều khiển. Từ đây bạn có thể:
 * **Khởi động / Dừng (Start / Stop)** bot chạy ẩn.
 * **Cấu hình Workspace**: Quản lý các thư mục mà phiên terminal được phép khởi chạy từ đó.
 * **Tự động khởi động (Autostart)**: Thiết lập ứng dụng tự chạy khi hệ thống khởi động.
@@ -75,7 +125,7 @@ Khi bot đang hoạt động, bạn có thể tương tác với nó thông qua
    * **▲ Up / ▼ Down** — Duyệt lại lịch sử các lệnh đã gõ.
 
 #### **📂 Thư Mục Làm Việc (Workspaces)**
-* Chọn **📁 Workspaces** từ menu chính để xem danh sách các thư mục được cấu hình trong `data/workspaces.json`.
+* Chọn **📁 Workspaces** từ menu chính để xem danh sách các thư mục được cấu hình.
 * Việc chọn một workspace sẽ đổi thư mục hiện tại của phiên PTY tiếp theo sang thư mục đó.
 
 #### **⚙️ Cấu Hình Hệ Thống Động**
@@ -85,61 +135,9 @@ Khi bot đang hoạt động, bạn có thể tương tác với nó thông qua
 
 ---
 
-## 🛠️ Hướng Dẫn Cài Đặt
-
-### 1. Yêu Cầu Hệ Thống
-Hãy chắc chắn rằng máy tính của bạn đã cài đặt [Node.js](https://nodejs.org/) (v18+) và `npm`.
-
-### 2. Cài Đặt
-Tải mã nguồn và cài đặt các thư viện cần thiết:
-```bash
-git clone https://github.com/quangnv13/nonstop.git
-cd nonstop
-npm install
-```
-
-### 3. Biên Dịch Dự Án
-Biên dịch các tệp TypeScript sang mã JavaScript chạy chính thức:
-```bash
-npm run build
-```
-
-### 4. Khởi Chạy `nonstop`
-Khởi động giao diện trung tâm điều khiển TUI:
-```bash
-npm start
-```
-> [!NOTE]
-> Trong lần chạy đầu tiên, nếu tệp `.env` chưa tồn tại, `nonstop` sẽ tự động hiển thị **Trình hướng dẫn thiết lập (Setup Wizard)** để giúp bạn điền Token Telegram, tên người dùng Admin được phép truy cập, ngôn ngữ và cấu hình khởi động.
-
-Với chế độ phát triển (hỗ trợ hot-reload):
-```bash
-npm run dev
-```
-
----
-
-## 📁 Cấu Trúc Dự Án
-
-```text
-nonstop/
-├── data/               # Lưu trữ dữ liệu (logs, workspaces.json, last-chat-id)
-├── src/                # Mã nguồn viết bằng TypeScript
-│   ├── bot.ts          # Xử lý bot Telegram & các callback query
-│   ├── config.ts       # Phân tích cấu hình, ghi tệp cấu hình & nạp biến môi trường
-│   ├── runtime.ts      # Quản lý shell session & tiến trình PTY
-│   ├── ui.ts           # Giao diện trung tâm điều khiển TUI
-│   └── index.ts        # Điểm khởi chạy ứng dụng
-├── dist/               # Mã JavaScript sau khi biên dịch
-├── .env                # Lưu trữ cấu hình môi trường cục bộ (được bỏ qua bởi git)
-└── package.json        # Định nghĩa dự án & các script chạy lệnh
-```
-
----
-
 ## 🎛️ Cấu Hình Ban Đầu
 
-Các cài đặt cấu hình nằm trong file `.env` tại thư mục gốc của dự án. Bạn có thể tạo từ tệp mẫu [`.env.example`](.env.example):
+Các cài đặt cấu hình nằm trong file `.env` tại thư mục nơi bạn chạy lệnh CLI. Tệp mẫu cấu hình `.env.example` sẽ được tự động sinh ra:
 
 ```ini
 TELEGRAM_BOT_TOKEN=your_telegram_bot_token
@@ -157,7 +155,7 @@ STARTUP_MODE=disabled
 > [!WARNING]
 > Do `nonstop` cung cấp quyền truy cập shell trực tiếp trên máy của bạn thông qua ứng dụng Telegram, hãy lưu ý các quy tắc bảo mật sau:
 >
-> 1. **Giữ Bí Mật Token Bot**: Tuyệt đối không commit tệp `.env` chứa token lên các kho lưu trữ công cộng.
+> 1. **Giữ Bí Mật Token Bot**: Tuyệt đối không để lộ tệp `.env` chứa token lên các kho lưu trữ công cộng.
 > 2. **Kiểm Tra Kỹ Tên Admin**: Đảm bảo `ADMIN_USERNAME` được điền đúng (bao gồm cả ký tự `@` ở đầu) để tránh kẻ xấu lợi dụng.
 > 3. **Chạy Với Quyền Hạn Hạn Chế**: Không nên chạy ứng dụng dưới các quyền quản trị cao nhất (như Administrator hoặc root) trừ khi thực sự cần thiết.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quangnv13/nonstop",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "publishConfig": {
     "access": "public"
   },