8
8
<a href =" https://github.com/sponsors/KyleTryon " >
9
9
<img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/KyleTryon">
10
10
</a >
11
- <img alt =" GitHub Workflow Status " src =" https://img.shields.io/github/actions/workflow/status/uhs-cli/UltimateHomeServer/commitlint.yml " >
11
+ <a href =" https://github.com/TechSquidTV/uhs-cli/actions/workflows/golangci-lint.yml " >
12
+ <img alt =" GitHub Workflow Status " src =" https://img.shields.io/github/actions/workflow/status/TechSquidTV/uhs-cli/golangci-lint.yml " >
13
+ </a >
12
14
<a href =" https://discord.gg/CTC9DVvYZz " >
13
15
<img alt="Discord" src="https://img.shields.io/discord/415249366840901643?style=plastic&logo=discord">
14
16
</a >
@@ -23,32 +25,60 @@ An interactive CLI to assist in configuring services for the <a href="https://gi
23
25
</p >
24
26
25
27
26
- ** Pre-Alpha :** This CLI is currently in active development and is not ready for use .
28
+ ** Beta :** This CLI is currently in active development and is subject to change .
27
29
28
30
29
31
# Getting Started
30
32
31
33
## Installation
32
34
33
- ### Go
35
+
36
+ ### Binary
37
+
38
+ Utilize the install script to download the latest release for your platform.
34
39
35
40
``` bash
36
- go install github. com/uhs-cli/uhs@latest
41
+ wget https://raw.githubusercontent. com/TechSquidTV/ uhs-cli/main/install.sh
37
42
```
38
43
39
- ### Binary
44
+ ``` bash
45
+ chmod +x install.sh
46
+ ```
40
47
41
- Visit the [ releases] ( ) section and download the latest release for your platform.
48
+ ``` bash
49
+ ./install.sh
50
+ ```
51
+
52
+ ### Go
42
53
43
54
``` bash
55
+ go install github.com/uhs-cli/uhs@latest
44
56
```
45
57
46
58
## Usage
47
59
48
60
``` bash
49
- uhs configure -o secrets.yaml
61
+ Usage:
62
+ uhs-cli [command]
63
+
64
+ Available Commands:
65
+ configure Configure your UHS instance
66
+ default Get the default configuration for UHS
67
+ help Help about any command
68
+
69
+ Flags:
70
+ -h, --help help for uhs-cli
71
+ -t, --toggle Help message for toggle
72
+ ```
73
+
74
+ Generate configurations for individual services:
75
+
76
+ ``` bash
77
+ uhs-cli configure < service> -o values.yaml
50
78
```
51
79
52
- ### Screencast
80
+ Generate a default configuration for all services:
53
81
54
- [ ![ asciicast] ( https://asciinema.org/a/R58ErthUiItMNwEmn06qpEKnU.svg )] ( https://asciinema.org/a/R58ErthUiItMNwEmn06qpEKnU )
82
+ ``` bash
83
+ uhs-cli default -o values.yaml
84
+ ```
0 commit comments