envlink 1.0.0 → 1.0.6

package/README.md

@@ -5,89 +5,59 @@ Secure and anonymous environment file sharing CLI - Share `.env` files with expi
 [![npm version](https://img.shields.io/npm/v/envlink.svg)](https://www.npmjs.com/package/envlink)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## Features
-
-- Secure sharing with encryption
-- Auto-expiration (minutes, hours, days, years, or never)
-- Optional password protection
-- No signup or authentication required
-- Share multiple files at once
-- Update existing EnvLinks
-
 ## Installation
 
+### Permanent Installation
+
 ```bash
 npm install -g envlink
 ```
 
-## Quick Start
+### One-Time Use (No Installation)
 
-### Create and Share
+You can use EnvLink without installing it permanently:
 
 ```bash
-cd my-project
-envlink create
-```
+# Using npx (Node.js)
+npx envlink create
+npx envlink install el_abc123xyz456
 
-### Install
+# Using bunx (Bun)
+bunx envlink create
+bunx envlink install el_abc123xyz456
 
-```bash
-envlink install <id>
+# Using pnpm
+pnpm dlx envlink create
+pnpm dlx envlink install el_abc123xyz456
 ```
 
-## Usage
+## Quick Start
 
-### Create EnvLink
+### Create and Share
 
 ```bash
-# Interactive mode
+cd my-project
 envlink create
-
-# With options
-envlink create --exp 7d
-envlink create --exp-pass mypassword
-envlink create --exp 5d --exp-pass secretpass
 ```
 
-**Expiration formats:** `30m`, `24h`, `5d`, `1y`, `never`
+Share the generated EnvLink ID with your team!
 
-### Install EnvLink
+### Install on Another Machine
 
 ```bash
-envlink install <id>
+envlink install el_abc123xyz456
 ```
 
-### View Info
+That's it! Your environment files are now installed.
 
-```bash
-envlink info <id>
-```
-
-### Update EnvLink
-
-```bash
-envlink update <id> --files
-envlink update <id> --exp never
-```
-
-### Expire EnvLink
+## Documentation
 
-```bash
-envlink expire <id>
-envlink expire <id> --exp-pass mypassword
-```
-
-### Help
-
-```bash
-envlink --help
-envlink create --help
-```
+- **[commands.md](./commands.md)** - Complete command reference including update, expire, and advanced options
+- **[faq.md](./faq.md)** - Frequently Asked Questions
 
 ## Security
 
-- End-to-end encryption
-- Password hashing with bcrypt
-- Automatic expiration
-- HTTPS transport only
-- No authentication required (anonymous)
+- Auto-expiration (configurable)
+- Optional password protection
+- No signup required
+- Anonymous sharing

package/commands.md

@@ -0,0 +1,135 @@
+# EnvLink CLI Commands Reference
+
+Complete command reference for EnvLink CLI tool.
+
+## Version & Help
+
+```bash
+# Show version number
+envlink -v
+envlink -V
+envlink --version
+
+# Show help for all commands
+envlink -h
+envlink --help
+
+# Show help for a specific command
+envlink help <command>
+```
+
+## Create Commands
+
+```bash
+# Interactive creation (prompts for files, expiration, password)
+envlink create
+
+# Create with 5 day expiration
+envlink create --exp 5d
+
+# Create with password protection
+envlink create --exp-pass <password>
+
+# Create with 1 year expiration and password
+envlink create --exp 1y --exp-pass <password>
+```
+
+**Expiration units:** `m` (minutes), `h` (hours), `d` (days), `M` (months), `y` (years), `never`
+
+## Install Commands
+
+```bash
+# Install all files from EnvLink
+envlink install <id>
+
+# Install with file selection prompt
+envlink install <id> -s
+envlink install <id> --select-files
+```
+
+## Info Commands
+
+```bash
+# Show EnvLink details (status, files, expiry, install count)
+envlink info <id>
+```
+
+## Update Commands
+
+```bash
+# Update files from current directory
+envlink update <id> -f
+envlink update <id> --files
+
+# Update expiration to 30 days
+envlink update <id> --exp 30d
+
+# Update/set expiration password
+envlink update <id> --exp-pass <new-password>
+
+# Provide current password for protected EnvLink
+envlink update <id> --current-pass <password>
+
+# Update files and set to never expire
+envlink update <id> -f --exp never
+
+# Update files with authentication
+envlink update <id> --files --current-pass <password>
+```
+
+## Expire Commands
+
+```bash
+# Manually expire an EnvLink (if not password protected)
+envlink expire <id>
+
+# Expire EnvLink with password validation
+envlink expire <id> --exp-pass <password>
+```
+
+## Examples
+
+### Basic Workflow
+
+```bash
+# 1. Create an EnvLink
+envlink create
+
+# 2. Check EnvLink status
+envlink info el_abc123xyz456
+
+# 3. Install on another machine
+envlink install el_abc123xyz456
+```
+
+### Advanced Workflow
+
+```bash
+# 1. Create 7-day link with password
+envlink create --exp 7d --exp-pass mypass123
+
+# 2. Update files later
+envlink update el_abc123xyz456 --files --current-pass mypass123
+
+# 3. Manually expire when done
+envlink expire el_abc123xyz456 --exp-pass mypass123
+```
+
+## Common Options
+
+| Option                      | Description                                                     |
+| --------------------------- | --------------------------------------------------------------- |
+| `--exp <duration>`          | Expiration duration: `30m`, `24h`, `5d`, `6M`, `1y`, or `never` |
+| `--exp-pass <password>`     | Password for protection/expiration                              |
+| `--current-pass <password>` | Current password (required for updating protected links)        |
+| `-f, --files`               | Update files flag                                               |
+| `-s, --select-files`        | File selection mode for install                                 |
+
+## Notes
+
+- **Default expiration:** 1 day if not specified
+- **EnvLink ID format:** `el_<16-char-alphanumeric>`
+- **Password protection:** Required for updates and manual expiration of protected links
+- **Expired links:** Cannot be installed or updated
+- **Never expire:** Use `--exp never` for permanent links
+- **Time units:** `m` (minutes), `h` (hours), `d` (days), `M` (months), `y` (years)