iamthefij/unhacs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
IamTheFij 2024-12-18 11:17:02 -08:00
parent 81bc8f2ccf
commit db568ff11c
1 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -10,13 +10,14 @@ pipx install unhacs
## Usage
Unhacs provides several commands to manage your Home Assistant packages:
Unhacs provides several commands to manage your Home Assistant packages. It stores installed or requsted packages in a lock file called `unhacs.yaml`. This makes it possible to version control your packages and easily share them with others.
### 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:
To add a package, use the `add` command followed by the URL of the package. Optionally, you can specify the package name and version. If no version is specified, the latest version will be installed:
```bash
unhacs add <package_url>
unhacs add <package_url> --version <version>
```
@ -26,24 +27,25 @@ If the package already exists, you can update it by adding the `--update` flag:
unhacs add <package_url> --update
```
If the package is a Lovelace plugin, you must specify it using the `--plugin` flag:
If the package is a Lovelace plugins or theme, install it using the appropriate flags:
```bash
unhacs add --plugin <package_url>
unhacs add --theme <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>
unhacs add --file ./unhacs.yaml
```
### Add a component from a forked Home Assistant Core repository
#### 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:
To add a component from a fork of home-assistant/core, use the `--fork-component` flag followed by the name ofthe component and then specify the branch with the `--fork-branch` flag:
```bash
unhacs add --forked-component <forked_repo_url> --branch <branch>
unhacs add --fork-component <component_name> --fork-branch <branch_name> <forked_repo_url>
```
### List packages
@ -52,11 +54,6 @@ 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
```
@ -66,11 +63,6 @@ To list all tags for a package, use the `tags` command followed by the name of t
```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
```