Skip to main content

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.

  1. Open the Bot and go to 👤 My Account -> 🔑 Generate API Key.
  2. In your terminal, run:
    akash login
    
  3. 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 vlc command is available in your system's PATH.
  • Forgot your key? Run akash login again to overwrite the old session.

🛡️ Powered by Akash Enterprise Core.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

akashcli-3.6.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

akashcli-3.6.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file akashcli-3.6.0.tar.gz.

File metadata

  • Download URL: akashcli-3.6.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for akashcli-3.6.0.tar.gz
Algorithm Hash digest
SHA256 99508fd3e597300c63f212af698279f2efd6c9e6f67beaba3ec9d6d91fc6a1bd
MD5 a4e69a90d3f7faf68ed6e79e22ac6436
BLAKE2b-256 b384ae594afcc8a31224f69f1b97f0bb22cc5a9de3cd035d8e490ba2f87190c8

See more details on using hashes here.

File details

Details for the file akashcli-3.6.0-py3-none-any.whl.

File metadata

  • Download URL: akashcli-3.6.0-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for akashcli-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c03147fdc26fcc888d057658c850b59cab5a459eb2d340183a3fd9199ec9afd2
MD5 7e3d312f048e095736791828fb97c7e7
BLAKE2b-256 2aa599b4ff4ea789bbad20d46d84a4ee60a32d01d932de546bf633db4324b188

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page