| Name | invokeai-models-cli JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | CLI tool for working with orphaned external models and the InvokeAI database |
| upload_time | 2024-09-27 14:13:13 |
| 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 Models CLI
[](https://pypi.org/project/invokeai-models-cli/)
[](https://pypi.org/project/invokeai-models-cli/)
> [!NOTE]
> Project features were driven by personal needs and not a sense to create a general-purpose tool. As such, the tool may not be suitable for all use cases. Please use it with caution and always back up your data before making any changes. It is not intended to replace the official Invoke AI web UI but provides additional functionality for managing orphaned models.
**InvokeAI Models CLI** is a simplified command-line tool for managing orphaned Invoke AI models left in the database after their external sources have been deleted. This tool allows you to list, compare, and delete models automatically or via an interactive selection menu.
## Why Use This Tool?
This tool addresses a personal pain point with unmanaged external models not handled by Invoke AI. It is not intended to replace the official Invoke AI web UI but provides additional functionality for managing orphaned models.
## Installation
Choose one of the following methods to install/run the tool:
### Using `pipx` (Recommended)
```bash
pipx install invokeai-models-cli
```
### Using `pip`
```bash
pip install .
```
Or, if you prefer a local installation with the ability to explore and modify the code:
```bash
pip install -e .
```
Make sure to create and activate a virtual environment before installing locally.
## Usage
After installation, use the following commands:
```bash
invokeai-models [OPTIONS] COMMAND [ARGS]
```
**Available Commands:**
- **database**
- `create-snapshot`: Create a snapshot of the current database state.
- `list-snapshots`: List available snapshots.
- `delete-snapshot`: Delete a snapshot by ID.
- `restore-snapshot`: Restore a snapshot by ID.
- **local-models**: Display local models information.
- **compare-models**: Compare models based on specific criteria (e.g., model name, hash).
- **sync-models**: Sync orphaned models with the current external sources or delete them if they no longer exist.
- **database-models**: List and manage models in the Invoke AI database, including orphaned ones.
## Examples
- Create a snapshot: `invokeai-models database create-snapshot`
- List snapshots: `invokeai-models database list-snapshots`
- Delete a snapshot: `invokeai-models database delete-snapshot`
- Restore a snapshot: `invokeai-models database restore-snapshot`
- Compare models: `invokeai-models compare-models`
Raw data
{
"_id": null,
"home_page": null,
"name": "invokeai-models-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/e7/bb/71d2e1be8f8f55f091f3ae8d4e580f97df42d906817e6cbbd42d86f8c340/invokeai_models_cli-1.1.0.tar.gz",
"platform": null,
"description": "# InvokeAI Models CLI\n\n[](https://pypi.org/project/invokeai-models-cli/)\n[](https://pypi.org/project/invokeai-models-cli/)\n\n> [!NOTE]\n> Project features were driven by personal needs and not a sense to create a general-purpose tool. As such, the tool may not be suitable for all use cases. Please use it with caution and always back up your data before making any changes. It is not intended to replace the official Invoke AI web UI but provides additional functionality for managing orphaned models.\n\n**InvokeAI Models CLI** is a simplified command-line tool for managing orphaned Invoke AI models left in the database after their external sources have been deleted. This tool allows you to list, compare, and delete models automatically or via an interactive selection menu.\n\n## Why Use This Tool?\n\nThis tool addresses a personal pain point with unmanaged external models not handled by Invoke AI. It is not intended to replace the official Invoke AI web UI but provides additional functionality for managing orphaned models.\n\n## Installation\n\nChoose one of the following methods to install/run the tool:\n\n### Using `pipx` (Recommended)\n\n```bash\npipx install invokeai-models-cli\n```\n\n### Using `pip`\n\n```bash\npip install .\n```\n\nOr, if you prefer a local installation with the ability to explore and modify the code:\n\n```bash\npip install -e .\n```\n\nMake sure to create and activate a virtual environment before installing locally.\n\n## Usage\n\nAfter installation, use the following commands:\n\n```bash\ninvokeai-models [OPTIONS] COMMAND [ARGS]\n```\n\n**Available Commands:**\n\n- **database**\n - `create-snapshot`: Create a snapshot of the current database state.\n - `list-snapshots`: List available snapshots.\n - `delete-snapshot`: Delete a snapshot by ID.\n - `restore-snapshot`: Restore a snapshot by ID.\n\n- **local-models**: Display local models information.\n\n- **compare-models**: Compare models based on specific criteria (e.g., model name, hash).\n\n- **sync-models**: Sync orphaned models with the current external sources or delete them if they no longer exist.\n\n- **database-models**: List and manage models in the Invoke AI database, including orphaned ones.\n\n## Examples\n\n- Create a snapshot: `invokeai-models database create-snapshot`\n- List snapshots: `invokeai-models database list-snapshots`\n- Delete a snapshot: `invokeai-models database delete-snapshot`\n- Restore a snapshot: `invokeai-models database restore-snapshot`\n- Compare models: `invokeai-models compare-models`\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 working with orphaned external models and the InvokeAI database",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/regiellis/invokeai_models_cli/issues",
"Documentation": "https://github.com/regiellis/invokeai_models_cli/blob/main/README.md",
"Repository": "https://github.com/regiellis/invokeai_models_cli"
},
"split_keywords": [
"ai",
" cli",
" generative-ai",
" invokeai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "973b3ab651018d9cd0ab386e88c35271f900183375b00303ce097b0c759b9f62",
"md5": "e02f426678e22b7139406ad1c468a832",
"sha256": "6dbc02a47231964faa7ff4a279995fb32e033db2e6ec0d32b34eab58caaee396"
},
"downloads": -1,
"filename": "invokeai_models_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e02f426678e22b7139406ad1c468a832",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 16305,
"upload_time": "2024-09-27T14:13:12",
"upload_time_iso_8601": "2024-09-27T14:13:12.181813Z",
"url": "https://files.pythonhosted.org/packages/97/3b/3ab651018d9cd0ab386e88c35271f900183375b00303ce097b0c759b9f62/invokeai_models_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7bb71d2e1be8f8f55f091f3ae8d4e580f97df42d906817e6cbbd42d86f8c340",
"md5": "b0a329fe1d11cc4b9ddef4c9313725aa",
"sha256": "ce678e4d99fdd8ce0ffd3ffd2f1ca0fbe6a1379bf35acd9edc1ce3a3ca7281a2"
},
"downloads": -1,
"filename": "invokeai_models_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b0a329fe1d11cc4b9ddef4c9313725aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14660,
"upload_time": "2024-09-27T14:13:13",
"upload_time_iso_8601": "2024-09-27T14:13:13.595910Z",
"url": "https://files.pythonhosted.org/packages/e7/bb/71d2e1be8f8f55f091f3ae8d4e580f97df42d906817e6cbbd42d86f8c340/invokeai_models_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 14:13:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "regiellis",
"github_project": "invokeai_models_cli",
"github_not_found": true,
"lcname": "invokeai-models-cli"
}
