Enterprise Developer SDK and CLI for Akash Vault
Project description
To get started with AkashCLI, your users should follow these steps. You can provide this guide as a README.md or a "Getting Started" message in your bot.
🚀 Akash Vault: Getting Started Guide
AkashCLI is the professional command-line interface and SDK for interacting with your E2E encrypted vault. Follow these steps to install and secure your first files.
1. Prerequisites
Ensure you have Python 3.10+ and pip installed on your machine (Linux, Termux, Mac, or Windows).
2. Installation
Since this is a custom package, users can install it directly from your source code or repository:
# Clone the repository
git clone https://github.com/juniorsir/akashcli
cd akashcli
# Install in editable mode
pip install . --break-system-packages
3. First-Time Setup (Authentication)
Before using the vault, you must link your device using an API Key generated from the Akash Telegram Bot.
- Open the Bot and go to 👤 My Account -> 🔑 Generate API Key.
- In your terminal, run:
akash login - Enter your API Key when prompted. Your key will be encrypted and bound to your hardware automatically.
4. Daily Workflow Commands
📤 Uploading Content
Upload a file:
akash upload movie.mp4
Upload a secret text snippet:
akash upload --text "My secret server password is 1234" --name "passwords.txt"
Upload with security flags:
# Delete automatically after the first person views it
akash upload --burn secret_doc.pdf
# Set a 7-day expiry
akash upload --expiry 7 data_backup.zip
📦 Managing the Vault
List your most recent files:
akash files
Get file details or secure links:
akash stream FILE_CODE
Delete a file permanently:
akash delete FILE_CODE
5. Professional Features
🚀 Bulk Vaulting
Vault an entire folder of documents or images at once:
akash bulk ./my_documents_folder
🎬 Native Streaming
Stream a vaulted video directly into VLC Media Player without downloading:
akash stream FILE_CODE --vlc
📊 System Health
Check your remaining quota and vault status:
akash admin
6. Using the SDK (For Developers)
If you are building your own Python scripts, you can import the library directly:
from akashcli import AkashClient
# Initialize client (uses your encrypted local config)
client = AkashClient()
# Vault a log file
result = client.upload_file("system.log", expiry=30)
print(f"File secured! Access it at: {result.embed_url}")
# List all your files programmatically
for file in client.list_files():
print(f"{file.name} -> {file.code}")
💡 Troubleshooting
- Access Denied? Ensure you have set your API Key domains to
*in the Telegram Bot under "Edit Domains." - VLC not opening? Ensure the
vlccommand is available in your system's PATH. - Forgot your key? Run
akash loginagain to overwrite the old session.
🛡️ Powered by Akash Enterprise Core.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file akashcli-3.0.0.tar.gz.
File metadata
- Download URL: akashcli-3.0.0.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f8f4f4213cba2ceaf3f19176576d0f9d139959b0b9bd4490db355a67874ba1a
|
|
| MD5 |
ba494c7dacd93410aa8738bfaa469c22
|
|
| BLAKE2b-256 |
1eb3034fb4a4dc3eb01a29587676c03390416a3bbeb5a04d932aec63554f806a
|
File details
Details for the file akashcli-3.0.0-py3-none-any.whl.
File metadata
- Download URL: akashcli-3.0.0-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
365b4cb0df185060e54ab40d48b89838c6c99558a3c1414388d8463fa5ae383a
|
|
| MD5 |
a6484ffcf731df35f6ea65606ab71aaa
|
|
| BLAKE2b-256 |
99cd1b5ad4b590f09acd209fda23e9dd643408f82a897808a1f9c194797bedc7
|