Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cloakx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🕶️ Cloakx CLI

Cloakx is a secure, lightweight, and developer-friendly CLI tool for managing encrypted key-value data locally. It's like your personal developer vault — simple, fast, and customizable!

🔐 Perfect for storing API keys, tokens, secrets, or any sensitive data from the terminal.

✨ Features

🔐 Login system using vault password
💾 Securely store and retrieve key-value pairs
✏️ Update existing secrets easily
❌ Delete secrets by key
📜 List all stored keys
📂 Configurable JSON-based local vault
⚙️ Fully extensible and modular design

📦 Installation

Install cloakx globally using npm:

npm install -g cloakx

🚀 Getting Started

Here are the basic commands you can use after installing cloakx.

cloakx login

Enter your vault password. This creates a secure session.

📥 Add a Secret

cloakx add <key>

Add a new secret with a key name. You'll be prompted to enter the value.

🔍 Get a Secret

cloakx get <key>

Fetch the value stored under the specified key.

📝 Update a Secret

cloakx update <key>

Update an existing key with a new value.

❌ Delete a Secret

cloakx delete <key>

Remove a secret by its key.

📜 List All Keys

cloakx list

Show all saved keys in the vault.

🔓 Logout

cloakx logout

Destroy the current session and clear temporary credentials.

⚙️ Configuration (Optional)

The vault and session files are stored locally:
- Vault: ~/.cloakx/vault.json
- Session: ~/.cloakx/session.json

🛠 Example Workflow

cloakx login
cloakx add github_token
cloakx get github_token
cloakx update github_token
cloakx list
cloakx delete github_token
cloakx logout

🔗 GitHub Repository

👉 https://github.com/pravinxdev/cloak

Star ⭐ the repo, report issues, or contribute!

🤝 Contributing

We welcome all contributions — from code improvements to feature suggestions or even documentation edits!

Steps to Contribute:

🍴 Fork the repo
🔧 Create your feature branch (git checkout -b feature-name)
✅ Commit your changes (git commit -m 'Add some feature')
📤 Push to the branch (git push origin feature-name)
📩 Open a pull request

📫 Contact

Want to collaborate, suggest ideas, or just say hi?

📧 Mail: pravins.dev@gmail.com

📜 License

MIT License — free to use, modify, and share.

cloakx