| Name | invokeai-presets-cli JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | CLI tool for streamlining the process of installing InvokeAI preset styles |
| upload_time | 2024-09-20 12:54:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2024 Regi E Ellis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ai
cli
generative-ai
invokeai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# InvokeAI Preset CLI
> [!IMPORTANT]
> This tool makes changes to the Invoke AI database and while it does make snapshots before operations
> that write to a table, there is always a chance the data could become corrupted. Use stand-alone tools
> if you are paranoid about losing data. This tool is provided as-is and is not guaranteed to work in all
> environments. It is recommended to backup your database before using this tool at least once.
## Overview
**InvokeAI Preset CLI** is a simple CLI tool that streamlines the process of managing large
entries of presets into the Invoke AI. The tool was primarily designed to allow me to quickly
add, update, and delete presets in bulk.
Presets/styles can be found at the [gist.github.com/regiellis](https://gist.github.com/regiellis/af5fc6a046d69d62036c6e9be2ff08da)
make sure to use the raw link to import the styles.
These styles are re-post of the work from the great people at:
[twri](https://github.com/twri), [3Diva](https://github.com/3Diva), [Marc K3nt3L](https://github.com/K3nt3L), and the
[fooocus](https://github.com/lllyasviel/Fooocus) project. Show your love on their projects.
## Why
Just wanted a easy way to get presets in and out of the database without having to use the web interface. The web interface is great for one-off presets,
and does have a bulk import feature, but I wanted to be able to do it from the command line with a litte more control over the process. I have also
added a few features that are not available in the web interface.
## Installation (Recommended)
You have a couple of options for installing/running the tool:
### Install [pipx](https://pipxproject.github.io/pipx/installation/), then run the tool with the following command
```bash
pipx install invokeai-presets-cli
```
### Alternatively, you can install using `pip`
```bash
pip install .
```
## Configuration
> [!IMPORTANT]
> Before using the tool, It's required to set up a `.env` file in the parent directory of the script or your home user dir [windows] or `$HOME/.config/invoke-presets-itsjustregi/.env`
> You will be asked to create a new `.env` file if it does not exist.
The application intelligently locates your `.env` file, accommodating various platforms like Windows and Linux, or defaulting to the current directory.
## Usage // Available Commands
Once installed via pipx or pip:
```
invoke-presets about -readme -changelog -version [-c, -r, -v]
invoke-presets list [--all, --only-defaults]
invoke-presets database create-snapshot
invoke-presets database list-snapshots
invoke-presets database delete-snapshot
invoke-presets database restore-snapshot
invoke-presets tools
invoke-presets export
invoke-presets import
invoke-presets delete
```
### Contact
For any inquiries, feedback, or suggestions, please feel free to open an issue on this repository.
### License
This project is licensed under the [MIT License](LICENSE).
---
Raw data
{
"_id": null,
"home_page": null,
"name": "invokeai-presets-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ai, cli, generative-ai, invokeai",
"author": null,
"author_email": "Regi E <regi@bynine.io>",
"download_url": "https://files.pythonhosted.org/packages/ac/ab/55b1d7c77b0a15db19f0978fc3add391e8331b9913533de8536b6a0607f9/invokeai_presets_cli-1.1.0.tar.gz",
"platform": null,
"description": "# InvokeAI Preset CLI\n\n> [!IMPORTANT]\n> This tool makes changes to the Invoke AI database and while it does make snapshots before operations\n> that write to a table, there is always a chance the data could become corrupted. Use stand-alone tools\n> if you are paranoid about losing data. This tool is provided as-is and is not guaranteed to work in all\n> environments. It is recommended to backup your database before using this tool at least once.\n\n## Overview\n\n**InvokeAI Preset CLI** is a simple CLI tool that streamlines the process of managing large\nentries of presets into the Invoke AI. The tool was primarily designed to allow me to quickly\nadd, update, and delete presets in bulk.\n\nPresets/styles can be found at the [gist.github.com/regiellis](https://gist.github.com/regiellis/af5fc6a046d69d62036c6e9be2ff08da)\nmake sure to use the raw link to import the styles.\n\nThese styles are re-post of the work from the great people at:\n[twri](https://github.com/twri), [3Diva](https://github.com/3Diva), [Marc K3nt3L](https://github.com/K3nt3L), and the\n[fooocus](https://github.com/lllyasviel/Fooocus) project. Show your love on their projects.\n\n\n\n\n## Why\n\nJust wanted a easy way to get presets in and out of the database without having to use the web interface. The web interface is great for one-off presets,\nand does have a bulk import feature, but I wanted to be able to do it from the command line with a litte more control over the process. I have also\nadded a few features that are not available in the web interface.\n\n\n\n## Installation (Recommended)\n\nYou have a couple of options for installing/running the tool:\n\n### Install [pipx](https://pipxproject.github.io/pipx/installation/), then run the tool with the following command\n\n```bash\npipx install invokeai-presets-cli\n```\n\n### Alternatively, you can install using `pip`\n\n```bash\npip install .\n```\n\n## Configuration\n\n> [!IMPORTANT]\n> Before using the tool, It's required to set up a `.env` file in the parent directory of the script or your home user dir [windows] or `$HOME/.config/invoke-presets-itsjustregi/.env`\n> You will be asked to create a new `.env` file if it does not exist.\n\nThe application intelligently locates your `.env` file, accommodating various platforms like Windows and Linux, or defaulting to the current directory.\n\n## Usage // Available Commands\n\nOnce installed via pipx or pip:\n\n```\ninvoke-presets about -readme -changelog -version [-c, -r, -v]\ninvoke-presets list [--all, --only-defaults]\ninvoke-presets database create-snapshot\ninvoke-presets database list-snapshots\ninvoke-presets database delete-snapshot\ninvoke-presets database restore-snapshot\ninvoke-presets tools\ninvoke-presets export \ninvoke-presets import \ninvoke-presets delete\n```\n\n\n\n\n### Contact\n\nFor any inquiries, feedback, or suggestions, please feel free to open an issue on this repository.\n\n### License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n---\n",
"bugtrack_url": null,
"license": "Copyright 2024 Regi E Ellis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "CLI tool for streamlining the process of installing InvokeAI preset styles",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/regiellis/invokeai_presets_cli/issues",
"Documentation": "https://github.com/regiellis/invokeai_presets_cli/blob/main/README.md",
"Repository": "https://github.com/regiellis/invokeai_presets_cli"
},
"split_keywords": [
"ai",
" cli",
" generative-ai",
" invokeai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd789e34471cb84013d694a9e5ba2c4a4723a0c6ba36d4ce98b5b1ba6b5c0058",
"md5": "73fe9ae1b467c6fa7a497d61bcaf58d2",
"sha256": "3d25966c967855c38a827e260cce41514cffea2fa085b99d6983434e6153c75c"
},
"downloads": -1,
"filename": "invokeai_presets_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73fe9ae1b467c6fa7a497d61bcaf58d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15806,
"upload_time": "2024-09-20T12:54:31",
"upload_time_iso_8601": "2024-09-20T12:54:31.700588Z",
"url": "https://files.pythonhosted.org/packages/dd/78/9e34471cb84013d694a9e5ba2c4a4723a0c6ba36d4ce98b5b1ba6b5c0058/invokeai_presets_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acab55b1d7c77b0a15db19f0978fc3add391e8331b9913533de8536b6a0607f9",
"md5": "2e21e683d89125a850b3fcf16fe768c1",
"sha256": "dece81f8e9068c4eee1a0abc9a9879f52a75664ba9d6a1986cb6168d4645acb4"
},
"downloads": -1,
"filename": "invokeai_presets_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2e21e683d89125a850b3fcf16fe768c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14160,
"upload_time": "2024-09-20T12:54:33",
"upload_time_iso_8601": "2024-09-20T12:54:33.276423Z",
"url": "https://files.pythonhosted.org/packages/ac/ab/55b1d7c77b0a15db19f0978fc3add391e8331b9913533de8536b6a0607f9/invokeai_presets_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 12:54:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "regiellis",
"github_project": "invokeai_presets_cli",
"github_not_found": true,
"lcname": "invokeai-presets-cli"
}
