You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# lw (liquidweb-cli)
1
+
# lw-cli (liquidweb-cli)
2
2
Official command line interface for the LiquidWeb API
3
3
```
4
4
CLI interface for LiquidWeb.
@@ -19,7 +19,7 @@ As always, consult the various subcommands for specific features and
19
19
capabilities.
20
20
21
21
Usage:
22
-
lw [command]
22
+
lw-cli [command]
23
23
24
24
Available Commands:
25
25
asset All things assets
@@ -36,23 +36,23 @@ Available Commands:
36
36
37
37
Flags:
38
38
--config string config file (default is $HOME/.liquidweb-cli.yaml)
39
-
-h, --help help for lw
39
+
-h, --help help for lw-cli`
40
40
--use-context string forces current context, without persisting the context change
41
41
42
-
Use "lw [command] --help" for more information about a command.
42
+
Use "lw-cli [command] --help" for more information about a command.
43
43
```
44
44
## Obtaining prebuilt binaries
45
45
46
46
Head on over to the [releases page](https://github.com/liquidweb/liquidweb-cli/releases) to get prebuilt binaries for your platform.
47
47
48
48
## Building from source
49
49
50
-
You can build lw from source by running `make build` from the root of this repository. The resulting program will be located at `./_exe/lw`.
51
-
You can also build+install lw onto your system in the ordinary `go install` way. To do this, either just run `go install` from the root of this repository,
50
+
You can build lw-cli from source by running `make build` from the root of this repository. The resulting program will be located at `./_exe/lw-cli`.
51
+
You can also build+install lw-cli onto your system in the ordinary `go install` way. To do this, either just run `go install` from the root of this repository,
52
52
or `make install`. If you run `make` with no arguments, this will be the default action.
53
53
54
54
## First Time Setup
55
-
The first time you use lw, you will need to setup an auth context. An auth context holds authentication related data for a specific LiquidWeb account. You can follow a guided questionnaire to add your auth contexts if you pass arguments `auth init` to lw. By default contexts are stored in `~/.liquidweb-cli.yaml` or `%APPDATA%/.liquidweb-cli.yaml` on Windows.
55
+
The first time you use lw-cli, you will need to setup an auth context. An auth context holds authentication related data for a specific LiquidWeb account. You can follow a guided questionnaire to add your auth contexts if you pass arguments `auth init` to lw-cli. By default contexts are stored in `~/.liquidweb-cli.yaml` or `%APPDATA%/.liquidweb-cli.yaml` on Windows.
56
56
57
57
## Adding auth contexts later
58
58
If you end up wanting to add an auth context later on, you can do so with `auth add-context`. You can find the usage documentation in `help auth add-context`.
@@ -76,7 +76,7 @@ For current commands supported via plans, take a look in the `examples/plans` di
76
76
77
77
Example:
78
78
79
-
`lw plan --file plan.yaml`
79
+
`lw-cli plan --file plan.yaml`
80
80
81
81
```
82
82
---
@@ -110,7 +110,7 @@ If you wanted to pass user defined variables on the command line you would use t
110
110
(multiple `--var` flags can be passed). For example, if you wanted to generate the hostname of
111
111
`web3.somehost.org` you would use the following command and yaml:
112
112
113
-
`lw plan --file play.yaml --var node=3 --var role=web`
113
+
`lw-cli plan --file play.yaml --var node=3 --var role=web`
0 commit comments