| Name | teller-cli JSON |
| Version |
0.3.10
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-04-22 03:16:47 |
| maintainer | |
| docs_url | None |
| author | JakePIXL |
| requires_python | >=3.9,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Checkout the [Technical Write-Up](https://dev.to/valink/crafting-robust-minecraft-backup-tools-a-deep-dive-into-chunkvault-lite-and-teller-cli-16d1) which explains how Teller-CLI works and how to install it.
## 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)
Raw data
{
"_id": null,
"home_page": "",
"name": "teller-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "JakePIXL",
"author_email": "jakewjevans@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e2/8f/375278011c7d0ff28f5acd630057c1733135114283e4b6972fcbdc2f5309/teller_cli-0.3.10.tar.gz",
"platform": null,
"description": "# Teller-CLI for ChunkVault-Lite\n\nTeller-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.\n\nCheckout the [Technical Write-Up](https://dev.to/valink/crafting-robust-minecraft-backup-tools-a-deep-dive-into-chunkvault-lite-and-teller-cli-16d1) which explains how Teller-CLI works and how to install it.\n\n## Testing\n\nLimited testing was done on MacOS 13 and Windows 10\n\n## Usage\n\nTo use Teller-CLI, first install the tool:\n\n```bash\n pip install teller-cli\n```\n\nThen, run the following command to create a snapshot:\n\n```bash\n teller-cli upload \"/path/to/world\"\n```\n\nThis will upload the specified backup to ChunkVault-Lite.\n\n### First Launch\n\nOn 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.\n\nAfter 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.\n\nOnce 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.\n\n---\n\n## Additional Information\n\nChunkVault-Lite is hosted in a separatly. For more information on ChunkVault-Lite visit the [Repository](https://github.com/Valink-Solutions/ChunkVault-Lite)\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.3.10",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "363f039a06f770d65d0ff0797ff252c5cc2b3d398cade9de23877946ac42e3a1",
"md5": "00479fcf963e628e37a811ef064d9340",
"sha256": "12dfef6a59f4b28391b65eb84f0cc13560b9766af0785be9ab0cd077649c14af"
},
"downloads": -1,
"filename": "teller_cli-0.3.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00479fcf963e628e37a811ef064d9340",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 10460,
"upload_time": "2023-04-22T03:16:45",
"upload_time_iso_8601": "2023-04-22T03:16:45.714582Z",
"url": "https://files.pythonhosted.org/packages/36/3f/039a06f770d65d0ff0797ff252c5cc2b3d398cade9de23877946ac42e3a1/teller_cli-0.3.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e28f375278011c7d0ff28f5acd630057c1733135114283e4b6972fcbdc2f5309",
"md5": "0d97ac5bae3deb75459eaf9c40926855",
"sha256": "3d3c87527f7e323d1753b80c56e0d543bfe3e9952fd48f6c3d9f5afa45424dae"
},
"downloads": -1,
"filename": "teller_cli-0.3.10.tar.gz",
"has_sig": false,
"md5_digest": "0d97ac5bae3deb75459eaf9c40926855",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 9342,
"upload_time": "2023-04-22T03:16:47",
"upload_time_iso_8601": "2023-04-22T03:16:47.436253Z",
"url": "https://files.pythonhosted.org/packages/e2/8f/375278011c7d0ff28f5acd630057c1733135114283e4b6972fcbdc2f5309/teller_cli-0.3.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-22 03:16:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "teller-cli"
}
