Metadata-Version: 2.4
Name: akashcli
Version: 3.0.0
Summary: Enterprise Developer SDK and CLI for Akash Vault
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: httpx
Requires-Dist: typer[all]
Requires-Dist: rich
Requires-Dist: cryptography

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:

```bash
# 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](https://t.me/EveryDL_bot).

1.  Open the Bot and go to **👤 My Account** -> **🔑 Generate API Key**.
2.  In your terminal, run:
    ```bash
    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:**
```bash
akash upload movie.mp4
```

**Upload a secret text snippet:**
```bash
akash upload --text "My secret server password is 1234" --name "passwords.txt"
```

**Upload with security flags:**
```bash
# 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:**
```bash
akash files
```

**Get file details or secure links:**
```bash
akash stream FILE_CODE
```

**Delete a file permanently:**
```bash
akash delete FILE_CODE
```

---

## 5. Professional Features

### 🚀 Bulk Vaulting
Vault an entire folder of documents or images at once:
```bash
akash bulk ./my_documents_folder
```

### 🎬 Native Streaming
Stream a vaulted video directly into **VLC Media Player** without downloading:
```bash
akash stream FILE_CODE --vlc
```

### 📊 System Health
Check your remaining quota and vault status:
```bash
akash admin
```

---

## 6. Using the SDK (For Developers)
If you are building your own Python scripts, you can import the library directly:

```python
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.**
