106 lines
2.1 KiB
Markdown
106 lines
2.1 KiB
Markdown
# unhacs
|
|
|
|
A command line alternative to the "Home Assistant Community Store", aka HACS
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pipx install unhacs
|
|
```
|
|
|
|
## Usage
|
|
|
|
Unhacs provides several commands to manage your Home Assistant packages:
|
|
|
|
### Add a package
|
|
|
|
To add a package, use the `add` command followed by the URL of the package. Optionally, you can specify the package name and version:
|
|
|
|
```bash
|
|
unhacs add <package_url> --version <version>
|
|
```
|
|
|
|
If the package already exists, you can update it by adding the `--update` flag:
|
|
|
|
```bash
|
|
unhacs add <package_url> --update
|
|
```
|
|
|
|
If the package is a Lovelace plugin, you must specify it using the `--plugin` flag:
|
|
|
|
```bash
|
|
unhacs add --plugin <package_url>
|
|
```
|
|
|
|
If you already have a list of packages in a file, you can add them all at once using the `--file` flag:
|
|
|
|
```bash
|
|
unhacs add --file <file_path>
|
|
```
|
|
|
|
### List packages
|
|
|
|
To list all installed packages, use the `list` command:
|
|
|
|
```bash
|
|
unhacs list
|
|
```
|
|
|
|
For a more detailed output, add the `--verbose` flag:
|
|
|
|
```bash
|
|
unhacs list --verbose
|
|
```
|
|
|
|
### List tags
|
|
|
|
To list all tags for a package, use the `tags` command followed by the name of the package:
|
|
|
|
```bash
|
|
unhacs tags <package_url>
|
|
```
|
|
|
|
The number or returned tags is limited to 10 by default. To change this, add the `--limit` flag:
|
|
|
|
```bash
|
|
unhacs tags <package_url> --limit 20
|
|
```
|
|
|
|
### Remove a package
|
|
|
|
To remove a package, use the `remove` command followed by the name of the package:
|
|
|
|
```bash
|
|
unhacs remove <package_name>
|
|
```
|
|
|
|
### Upgrade packages
|
|
|
|
To upgrade all packages, use the `upgrade` command:
|
|
|
|
```bash
|
|
unhacs upgrade
|
|
```
|
|
|
|
To upgrade specific packages, add their names after the `upgrade` command:
|
|
|
|
```bash
|
|
unhacs upgrade <package_name_1> <package_name_2> ...
|
|
```
|
|
|
|
## Use git tags
|
|
|
|
By default, identification of releases uses the GitHub API. If you want to use git tags instead, you can add the `--git-tags` flag to the base command:
|
|
|
|
```bash
|
|
unhacs --git-tags add <package_url>
|
|
```
|
|
|
|
## License
|
|
|
|
Unhacs is licensed under the MIT License. See the LICENSE file for more details.
|
|
|
|
## Original repo
|
|
|
|
Originally hosted at https://git.iamthefij.com/iamthefij/unhacs.git
|