@nightowne/tas-cli 1.1.1 → 2.1.0

package/README.md

@@ -1,14 +1,25 @@
-# TAS — Telegram as Storage
+<p align="center">
+  <img src="assets/demo.gif" alt="TAS Demo" width="600">
+</p>
 
-[![CI](https://github.com/ixchio/tas/actions/workflows/ci.yml/badge.svg)](https://github.com/ixchio/tas/actions/workflows/ci.yml)
-[![npm](https://img.shields.io/npm/v/@nightowne/tas-cli)](https://www.npmjs.com/package/@nightowne/tas-cli)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+<h1 align="center">Telegram as Storage</h1>
 
 <p align="center">
-  <img src="assets/demo.gif" alt="TAS Demo" width="600">
+  <strong>Free, encrypted, unlimited cloud storage — inside Telegram.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/ixchio/tas/actions/workflows/ci.yml"><img src="https://github.com/ixchio/tas/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://www.npmjs.com/package/@nightowne/tas-cli"><img src="https://img.shields.io/npm/v/@nightowne/tas-cli" alt="npm"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+  <a href="https://www.npmjs.com/package/@nightowne/tas-cli"><img src="https://img.shields.io/npm/dm/@nightowne/tas-cli" alt="Downloads"></a>
 </p>
 
-A CLI tool that uses your Telegram bot as encrypted file storage. Files are compressed, encrypted locally, then uploaded to your private bot chat.
+---
+
+I built this because I wanted encrypted cloud storage that's actually free. Google Drive reads your files. Dropbox costs money. Telegram gives you unlimited storage with a bot API — so I wrote a CLI that turns it into a proper encrypted drive.
+
+**What this does:** Compresses, encrypts (AES-256-GCM), and uploads your files to your own private Telegram bot chat. Mount it as a folder, sync directories, or share files with expiring links.
 
 ```
 ┌─────────────┐     ┌───────────────┐     ┌──────────────┐
@@ -22,136 +33,130 @@ A CLI tool that uses your Telegram bot as encrypted file storage. Files are comp
 └─────────────┘     └───────────────┘     └──────────────┘
 ```
 
-## Why TAS?
-
-| Feature | TAS | Session-based tools (e.g. teldrive) |
-|---------|:---:|:-----------------------------------:|
-| Account ban risk | **None** (Bot API) | High (session hijack detection) |
-| Encryption | AES-256-GCM | Usually none |
-| Dependencies | SQLite only | Rclone, external DB |
-| Setup complexity | 2 minutes | Docker + multiple services |
+## ⚡ Quick Start
 
-**Key differences:**
-- Uses **Bot API**, not session-based auth — Telegram can't ban your account
-- **Encryption by default** — files encrypted before leaving your machine
-- **Local-first** — SQLite index, no cloud dependencies
-- **FUSE mount** — use Telegram like a folder
-
-## Security Model
-
-| Component | Implementation |
-|-----------|----------------|
-| Cipher | AES-256-GCM |
-| Key derivation | PBKDF2-SHA512, 100,000 iterations |
-| Salt | 32 bytes, random per file |
-| IV | 12 bytes, random per file |
-| Auth tag | 16 bytes (integrity) |
-
-Your password never leaves your machine. Telegram stores encrypted blobs.
+```bash
+npm install -g @nightowne/tas-cli
+tas init          # 2-minute setup wizard
+tas push secret.pdf
+tas pull secret.pdf
+```
 
-## Limitations
+## 🔥 Features
 
-- **Not a backup** — Telegram can delete content without notice
-- **No versioning** — overwriting a file deletes the old version
-- **49MB chunks** — files split due to Bot API limits
-- **FUSE required** — mount feature needs `libfuse` on Linux/macOS
-- **Single user** — designed for personal use, not multi-tenant
+### Mount as a folder
+```bash
+tas mount ~/cloud      # FUSE mount — drag & drop files
+tas unmount ~/cloud
+```
+Requires `libfuse` (`apt install fuse libfuse-dev` on Debian/Ubuntu, `brew install macfuse` on macOS).
 
-## Quick Start
+### Auto-sync folders
+```bash
+tas sync add ~/Documents    # Register
+tas sync start              # Watch for changes, auto-upload
+tas sync pull               # Download everything back
+```
 
+### Share files with expiring links
 ```bash
-# Install
-npm install -g @nightowne/tas-cli
+tas share create secret.pdf --expire 1h --max-downloads 3
+# → http://localhost:3000/d/a1b2c3d4...
 
-# Setup (creates bot connection + encryption password)
-tas init
+tas share list              # Active shares
+tas share revoke a1b2c3d4   # Revoke
+```
+Spins up a local HTTP server. File is downloaded from Telegram, decrypted, and served. Dark-themed download page with file info.
 
-# Upload a file
-tas push secret.pdf
+## 🛡️ Security
 
-# Download a file
-tas pull secret.pdf
+| Component | Implementation |
+|-----------|----------------|
+| Cipher | AES-256-GCM |
+| Key derivation | PBKDF2-SHA512, 100k iterations |
+| Salt | 32 bytes, random per file |
+| IV | 12 bytes, random per file |
+| Auth tag | 16 bytes (integrity verification) |
 
-# Mount as folder (requires libfuse)
-tas mount ~/cloud
-```
+Your password **never** leaves your machine. Telegram only sees encrypted blobs. Even if someone accesses your bot chat, they get meaningless data without your password.
 
-### Prerequisites
-- Node.js ≥18
-- Telegram account + bot token from [@BotFather](https://t.me/BotFather)
-- `libfuse` for mount feature:
-  ```bash
-  # Debian/Ubuntu
-  sudo apt install fuse libfuse-dev
-  
-  # Fedora
-  sudo dnf install fuse fuse-devel
-  
-  # macOS
-  brew install macfuse
-  ```
-
-## CLI Reference
+## 📋 Full CLI Reference
 
 ```bash
 # Core
 tas init                    # Setup wizard
-tas push <file>             # Upload file
-tas pull <file|hash>        # Download file
-tas list [-l]               # List files (long format)
-tas delete <file|hash>      # Remove file
-tas status                  # Show stats
-
-# Search & Resume (v1.1.0)
-tas search <query>          # Search by filename
-tas search -t <query>       # Search by tag
+tas push <file>             # Upload
+tas pull <file|hash>        # Download
+tas list [-l]               # List files
+tas delete <file|hash>      # Delete
+tas status                  # Stats
+tas search <query>          # Search files
 tas resume                  # Resume interrupted uploads
+tas verify                  # Check integrity
 
 # FUSE Mount
 tas mount <path>            # Mount as folder
 tas unmount <path>          # Unmount
 
+# Sync
+tas sync add <folder>       # Register folder
+tas sync start              # Start watching
+tas sync pull               # Download all
+tas sync status             # Show status
+
+# Share
+tas share create <file>     # Create download link
+tas share list              # Active shares
+tas share revoke <token>    # Revoke
+
 # Tags
-tas tag add <file> <tags...>    # Add tags
-tas tag remove <file> <tags...> # Remove tags
-tas tag list [tag]              # List tags or files by tag
+tas tag add <file> <tags...>
+tas tag remove <file> <tags...>
+tas tag list [tag]
+```
 
-# Sync (Dropbox-style)
-tas sync add <folder>       # Register folder for sync
-tas sync start              # Start watching
-tas sync pull               # Download all to sync folders
-tas sync status             # Show sync status
+## 🤖 Automation
+
+```bash
+# Skip password prompts
+export TAS_PASSWORD="your-password"
+tas push file.pdf
 
-# Verification
-tas verify                  # Check file integrity
+# Or inline
+tas push -p "password" file.pdf
 ```
 
-## Auto-Start (systemd)
+Works with cron, GitHub Actions, Docker, or any CI/CD.
 
-See [systemd/README.md](systemd/README.md) for running sync as a service.
+## ⚠️ Limitations
+
+- **Not a backup** — Telegram can delete content without notice
+- **No versioning** — overwriting deletes the old version
+- **49MB chunks** — files split due to Bot API limits
+- **Single user** — personal use, not multi-tenant
+- **FUSE required** — mount feature needs libfuse
 
-## Development
+## 🛠️ Development
 
 ```bash
 git clone https://github.com/ixchio/tas
-cd tas
-npm install
-npm test  # 28 tests
+cd tas && npm install
+npm test  # 43 tests
 ```
 
-### Project Structure
 ```
 src/
-├── cli.js           # Command definitions
+├── cli.js           # Commands
 ├── index.js         # Upload/download pipeline
-├── crypto/          # AES-256-GCM encryption
-├── db/              # SQLite file index
-├── fuse/            # FUSE filesystem mount
+├── crypto/          # AES-256-GCM
+├── db/              # SQLite index
+├── fuse/            # FUSE filesystem
+├── share/           # HTTP share server
 ├── sync/            # Folder sync engine
 ├── telegram/        # Bot API client
 └── utils/           # Compression, chunking
 ```
 
-## License
+## 📄 License
 
-MIT
+MIT — do whatever you want with it.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nightowne/tas-cli",
-  "version": "1.1.1",
-  "description": "📦 Telegram as Storage - Free encrypted cloud storage via Telegram. Mount Telegram as a folder!",
+  "version": "2.1.0",
+  "description": "Telegram as Storage - Automated encrypted cloud backup. Free, encrypted, scriptable. Mount as folder or use with cron/Docker.",
   "type": "module",
   "main": "src/index.js",
   "bin": {
@@ -54,4 +54,4 @@
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}