Metadata-Version: 2.1
Name: teller-cli
Version: 0.3.9
Summary: 
Author: JakePIXL
Author-email: jakewjevans@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: httpx (>=0.23.3,<0.24.0)
Requires-Dist: keyring (>=23.13.1,<24.0.0)
Requires-Dist: nanoid (>=2.0.0,<3.0.0)
Requires-Dist: nanoid-dictionary (>=2.4.0,<3.0.0)
Requires-Dist: nbtlib (>=2.0.4,<3.0.0)
Requires-Dist: prompt-toolkit (>=3.0.38,<4.0.0)
Requires-Dist: python-slugify (>=8.0.1,<9.0.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Description-Content-Type: text/markdown

# Teller-CLI for ChunkVault-Lite

Teller-CLI is an open source Python/Typer-based CLI tool for uploading Minecraft world backups to ChunkVault-Lite, an open source backup solution provided by Valink Solutions.

## Testing

Limited testing was done on MacOS 13 and Windows 10

## Usage

To use Teller-CLI, first install the tool:

```bash
    pip install teller-cli
```

Then, run the following command to create a snapshot:

```bash
    teller-cli upload "/path/to/world"
```

This will upload the specified backup to ChunkVault-Lite.

### First Launch

On first launch, Teller-CLI will prompt you to enter the API URL for your ChunkVault-Lite instance. The trailing slash is not necessary, so you can enter the URL without it.

After entering the API URL, Teller-CLI will prompt you to enter your API token. You can obtain this token from your ChunkVault-Lite instance. This token is required for authentication purposes and allows Teller-CLI to access your backups.

Once you have entered the API URL and token, Teller-CLI will store this information locally for future use. You can update this information at any time by running the `teller-cli config` command.

---

## Additional Information

ChunkVault-Lite is hosted in a separatly. For more information on ChunkVault-Lite visit the [Repository](https://github.com/Valink-Solutions/ChunkVault-Lite)

