# pyrecli
Command line utilities for DiamondFire templates
## Installation
Run the following command in a terminal:
```sh
pip install pyrecli
```
## Commands
- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))
- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))
- `rename`: Rename all occurences of a variable (including text codes)
- `script`: Generate python scripts from template data
- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))
- `docs`: Generate markdown documentation from template data
## What is this useful for?
- Backing up a plot
- Getting an accurate text representation of DF code
- Open sourcing
- Version control
- Large scale refactoring
## Example Usage
These two commands will scan your plot, convert each template into a python script, then place the scripts into a directory called `myplot`.
```sh
pyrecli scan templates.dfts
pyrecli script templates.dfts myplot
```
If you prefer the templates to be outputted to a single file, use the `--onefile` flag:
```sh
pyrecli scan templates.dfts
pyrecli script templates.dfts myplot.py --onefile
```
For more information about generating scripts, run `pyrecli script -h`.
Raw data
{
"_id": null,
"home_page": "https://github.com/Amp63/pyrecli",
"name": "pyrecli",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "diamondfire, minecraft, template, cli",
"author": "Amp",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/90/79/4c17ade0a0fc384f8bb93c3e6851d96ad2a55d2f63e4a00091629b1e94f7/pyrecli-0.1.2.tar.gz",
"platform": null,
"description": "# pyrecli\n\nCommand line utilities for DiamondFire templates\n\n## Installation\n\nRun the following command in a terminal:\n\n```sh\npip install pyrecli\n```\n\n## Commands\n\n- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))\n- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))\n- `rename`: Rename all occurences of a variable (including text codes)\n- `script`: Generate python scripts from template data\n- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))\n- `docs`: Generate markdown documentation from template data\n\n\n## What is this useful for?\n\n- Backing up a plot\n- Getting an accurate text representation of DF code\n- Open sourcing\n- Version control\n- Large scale refactoring\n\n\n## Example Usage\n\nThese two commands will scan your plot, convert each template into a python script, then place the scripts into a directory called `myplot`.\n\n```sh\npyrecli scan templates.dfts\npyrecli script templates.dfts myplot\n```\n\nIf you prefer the templates to be outputted to a single file, use the `--onefile` flag:\n\n```sh\npyrecli scan templates.dfts\npyrecli script templates.dfts myplot.py --onefile\n```\n\nFor more information about generating scripts, run `pyrecli script -h`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line utilities for DiamondFire templates",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/Amp63/pyrecli",
"Repository": "https://github.com/Amp63/pyrecli"
},
"split_keywords": [
"diamondfire",
" minecraft",
" template",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a28bf90275fb291a5d508f08ce76c917b9b5e7b1da815369048f4180578a2e0",
"md5": "be8c5e4555d028f3a9cf971fcd454396",
"sha256": "0f2e3ad984b1ea4e290e4cf55336a7b52a1024d2dcf410af2ee088c6fc706e4d"
},
"downloads": -1,
"filename": "pyrecli-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be8c5e4555d028f3a9cf971fcd454396",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 9948,
"upload_time": "2025-08-13T20:30:33",
"upload_time_iso_8601": "2025-08-13T20:30:33.732772Z",
"url": "https://files.pythonhosted.org/packages/4a/28/bf90275fb291a5d508f08ce76c917b9b5e7b1da815369048f4180578a2e0/pyrecli-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90794c17ade0a0fc384f8bb93c3e6851d96ad2a55d2f63e4a00091629b1e94f7",
"md5": "ef64b01964e03d4c25c30330a41b07f3",
"sha256": "3835b8929763ab0453deb36b6a1b38ee8af6d17be9dd3e26a30b888614a20bf8"
},
"downloads": -1,
"filename": "pyrecli-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ef64b01964e03d4c25c30330a41b07f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 7414,
"upload_time": "2025-08-13T20:30:34",
"upload_time_iso_8601": "2025-08-13T20:30:34.720823Z",
"url": "https://files.pythonhosted.org/packages/90/79/4c17ade0a0fc384f8bb93c3e6851d96ad2a55d2f63e4a00091629b1e94f7/pyrecli-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 20:30:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Amp63",
"github_project": "pyrecli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "amulet-nbt",
"specs": [
[
"==",
"2.1.5"
]
]
},
{
"name": "dfpyre",
"specs": [
[
"==",
"0.8.21"
]
]
},
{
"name": "mcitemlib",
"specs": [
[
"==",
"0.4.4"
]
]
},
{
"name": "mutf8",
"specs": [
[
"==",
"1.0.6"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "result",
"specs": [
[
"==",
"0.17.0"
]
]
},
{
"name": "websocket-client",
"specs": [
[
"==",
"1.8.0"
]
]
}
],
"lcname": "pyrecli"
}
JSON
