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.
1 maintainer
Metadata
1 maintainer
Release files for akashcli 4.5.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| akashcli-4.5.7.tar.gz | 72.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| akashcli-4.5.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 152.5 kB
Release files / akashcli-4.5.7.tar.gz
| Download URL | akashcli-4.5.7.tar.gz |
|---|---|
| Size | 72.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bc2e314a9619e941899e466688a160ff73a7cff0747093255ef799f2b9f3410b
|
|
BLAKE2b-256 checksum How to use checksums |
3eab93b1d8a0b4b23063c140bdf241e43d76fa747d54ef2b6f528bf35096d3be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / akashcli-4.5.7-py3-none-any.whl
| Download URL | akashcli-4.5.7-py3-none-any.whl |
|---|---|
| Size | 79.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f86a1b5945e52c0f414c705c0a04b39297a7ac428a68bb9fedc6573ae941f35
|
|
BLAKE2b-256 checksum How to use checksums |
497d99dea035fbe8aa4511eb635d42c33a64a9ef4d38112bbd4f46e48173aa20
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for akashcli 4.5.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
