k9cli v0.1.5

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.5

• Added detailed room filtering feature.

✨ 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 k9cli

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:

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 [-t|--type <type>] [-m|--minUsers <minUsers>] [-s|--sort <sort>] [-p|--page <page>] [-l|--limit <limit>]

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

🔒 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/k9cli.git

# Install dependencies
cd k9cli && npm install

# Link for development
npm link

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

K9Crypt CLI is MIT licensed.

Made with ❤️ by the K9Crypt Team

Report Bug • Request Feature