unhacs/README.md

114 lines
2.4 KiB
Markdown
Raw Normal View History

2024-06-04 22:20:13 +00:00
# unhacs
A command line alternative to the "Home Assistant Community Store", aka HACS
2024-06-10 21:26:42 +00:00
## 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
2024-07-08 17:38:37 +00:00
unhacs add <package_url> --version <version>
2024-06-10 21:26:42 +00:00
```
If the package already exists, you can update it by adding the `--update` flag:
```bash
2024-07-08 17:38:37 +00:00
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>
2024-06-10 21:26:42 +00:00
```
2024-08-18 18:10:49 +00:00
### Add a component from a forked Home Assistant Core repository
To add a component from a fork of home-assistant/core, use the `--forked-component` flag followed by the URL of the forked repository and then specify the branch with the `--branch` flag:
```bash
unhacs add --forked-component <forked_repo_url> --branch <branch>
```
2024-06-10 21:26:42 +00:00
### 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
```
2024-06-10 23:59:42 +00:00
### 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
```
2024-06-10 21:26:42 +00:00
### 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> ...
```
2024-06-10 23:59:42 +00:00
## 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>
```
2024-06-10 21:26:42 +00:00
## License
Unhacs is licensed under the MIT License. See the LICENSE file for more details.
2024-06-04 22:20:13 +00:00
## Original repo
Originally hosted at https://git.iamthefij.com/iamthefij/unhacs.git