K9crypt-cli NPM

Banner

K9Crypt CLI

🔐 Secure. Private. Real-time.

Transform your terminal into a fortress of secure communication. End-to-end encrypted chat rooms at your fingertips.

🧭 Updates

v0.1.3

Added new chat slash commands:
- /help - Shows available commands with descriptions
- /refresh - Reloads all messages in current chat
- /quit - Leaves room and closes chat gracefully
Enhanced message display:
- System messages now appear in yellow for better visibility
- Help command info shows in blue
Added user ID customization:
- New command: k9crypt set-username <userId>
- Users can now set their own display names
Added new data management commands:
- k9crypt clear - Clears all stored data
- k9crypt clear -y - Skips confirmation prompt when clearing data

✨ Features

🛡️ End-to-End Encryption - Military-grade security for your conversations
🚀 Real-time Chat - Lightning-fast message delivery
⏱️ Flexible Room Lifetimes - From ephemeral to permanent
🔒 Private Rooms - Password-protected spaces for confidential discussions
🎯 Simple Interface - Powerful functionality with minimal complexity
📱 Cross-Platform - Works seamlessly on macOS, Linux, and Windows

🚀 Quick Start

Installation

npm install -g k9crypt-cli

Set Username

k9crypt set-username JohnDoe # optional, but recommended

Create Your First Room

k9crypt create secret-room private mypassword -l day

Join and Start Chatting

k9crypt join 550e8400-e29b-41d4-a716-446655440000 # room id
k9crypt chat 550e8400-e29b-41d4-a716-446655440000 # room id

📖 Documentation

Chat Commands

While in an active chat session, you can use the following slash commands:

Command	Description
`/help`	Display available commands and usage information
`/quit`	Leave the current room and close chat
`/refresh`	Reload all messages in the current chat

Room Management

Create a new room with various options:

k9crypt create <room-name> <type> [password] [-l|--lifetime <duration>]

Join an existing room:

k9crypt join <room-name> [password] # if private room, provide password

Leave a room:

k9crypt leave <room-name>

View available rooms:

k9crypt list

Messaging

Send a message to a room:

k9crypt send <room-name> <message>

Start interactive chat:

k9crypt chat <room-id>

🗄️ Data Management

Clear all stored data:

k9crypt clear           # With confirmation prompt
k9crypt clear -y        # Skip confirmation

🏗️ Room Configuration

Types

public - Open rooms for community discussions
private - Password-protected rooms for confidential communication

Lifetime Options

Option	Duration	Use Case
`day`	24 hours	Quick discussions
`month`	30 days	Project coordination
`year`	365 days	Long-term collaboration
`permanent`	Forever	Persistent channels

🔒 Security

K9Crypt employs state-of-the-art encryption protocols to ensure:

End-to-end encryption for all messages
Zero-knowledge architecture
No message persistence outside specified lifetime
Secure key exchange protocols

🛠️ Development

Get started with development in three simple steps:

# Clone the repository
git clone https://github.com/k9crypt/k9crypt-cli.git

# Install dependencies
cd k9crypt-cli && npm install

# Link for development
npm link