Skip to content

Commit f8d286d

Browse files
authored
Update Docs with 0.4.5 CLI (#843)
## Summary Update Docs for 0.4.5 CLI based on #839 from @hezhizhen ## How was it tested? Localhost, using `yarn start`
1 parent 679af88 commit f8d286d

10 files changed

+265
-12
lines changed

docs/app/docs/cli_reference/devbox_cloud_forward.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,42 @@
11
# devbox cloud forward
2-
Port forwards a local port to a remote devbox cloud port.
32

4-
## Synopsis
3+
Port forwards a local port to a remote devbox cloud port. If 0 or no local port is specified, we find a suitable local port. Use 'stop' to stop all port forwards.
54

5+
```bash
6+
devbox cloud forward <local-port>:<remote-port> | :<remote-port> | stop | list [flags]
7+
```
68

9+
## Examples
710

811
```bash
912
# Connect remote port 3000 to an automatically assigned local port
1013
$ devbox cloud forward :3000
1114
Port forwarding 54653:3000
1215
To view in browser, visit http://localhost:54653
1316
```
17+
1418
```bash
1519
# Connect remote port 3000 to local port 3000
1620
$ devbox cloud forward 3000:3000
1721
Port forwarding 3000:3000
1822
To view in browser, visit http://localhost:3000
1923
```
24+
2025
```bash
2126
# Close all open port-forwards
2227
$ devbox cloud forward stop
2328
```
2429

25-
Usage:
26-
devbox cloud forward \<local-port\>:\<remote-port\> | :\<remote-port\> | stop | list [flags]
27-
devbox cloud forward [command]
30+
## Options
2831

29-
Available Commands:
30-
list Lists all port forwards managed by devbox
31-
stop Stops all port forwards managed by devbox
32-
33-
Flags:
32+
```text
3433
-h, --help help for forward
34+
-q, --quiet suppresses logs
35+
```
36+
37+
## SEE ALSO
38+
39+
* [devbox cloud](devbox_cloud.md) - [Preview] Remote development environments on the cloud
40+
* [devbox cloud forward list](devbox_cloud_forward_list.md) - Lists all port forwards managed by devbox
41+
* [devbox cloud forward stop](devbox_cloud_forward_stop.md) - Stops all port forwards managed by devbox
3542

36-
Global Flags:
37-
-q, --quiet suppresses logs.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# devbox cloud forward list
2+
3+
Lists all port forwards managed by devbox
4+
5+
```bash
6+
devbox cloud forward list [flags]
7+
```
8+
9+
## Options
10+
11+
```text
12+
-h, --help help for list
13+
-q, --quiet suppresses logs
14+
```
15+
16+
### SEE ALSO
17+
18+
* [devbox cloud forward](devbox_cloud_forward.md) - [Preview] Port forwards a local port to a remote devbox cloud port
19+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# devbox cloud forward stop
2+
3+
Stops all port forwards managed by devbox
4+
5+
```bash
6+
devbox cloud forward stop [flags]
7+
```
8+
9+
## Options
10+
11+
```text
12+
-h, --help help for stop
13+
-q, --quiet suppresses logs
14+
```
15+
16+
## SEE ALSO
17+
18+
* [devbox cloud forward](devbox_cloud_forward.md) - [Preview] Port forwards a local port to a remote devbox cloud port
19+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# devbox completion
2+
3+
Generate the autocompletion script for the specified shell
4+
5+
## Synopsis
6+
7+
Generate the autocompletion script for devbox for the specified shell.
8+
See each sub-command's help for details on how to use the generated script.
9+
10+
11+
## Options
12+
13+
```text
14+
-h, --help help for completion
15+
-q, --quiet suppresses logs-
16+
```
17+
18+
## SEE ALSO
19+
20+
* [devbox](devbox.md) - Instant, easy, predictable development environments
21+
* [devbox completion bash](devbox_completion_bash.md) - Generate the autocompletion script for bash
22+
* [devbox completion fish](devbox_completion_fish.md) - Generate the autocompletion script for fish
23+
* [devbox completion zsh](devbox_completion_zsh.md) - Generate the autocompletion script for zsh
24+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# devbox completion bash
2+
3+
Generate the autocompletion script for the bash shell.
4+
5+
This script depends on the 'bash-completion' package.
6+
If it is not installed already, you can install it via your OS's package manager.
7+
8+
To load completions in your current shell session:
9+
10+
```bash
11+
source <(devbox completion bash)
12+
```
13+
14+
To load completions for every new session, execute once:
15+
16+
## Linux
17+
18+
```bash
19+
devbox completion bash > /etc/bash_completion.d/devbox
20+
```
21+
22+
## macOS
23+
24+
```bash
25+
devbox completion bash > $(brew --prefix)/etc/bash_completion.d/devbox
26+
```
27+
28+
You will need to start a new shell for this setup to take effect.
29+
30+
31+
```bash
32+
devbox completion bash
33+
```
34+
35+
## Options
36+
37+
```text
38+
-h, --help help for bash
39+
--no-descriptions disable completion descriptions
40+
-q, --quiet suppresses logs
41+
```
42+
43+
## SEE ALSO
44+
45+
* [devbox completion](devbox_completion.md) - Generate the autocompletion script for the specified shell
46+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# devbox completion fish
2+
3+
Generate the autocompletion script for the fish shell.
4+
5+
To load completions in your current shell session:
6+
7+
```bash
8+
devbox completion fish | source
9+
```
10+
11+
To load completions for every new session, execute once:
12+
13+
```bash
14+
devbox completion fish > ~/.config/fish/completions/devbox.fish
15+
```
16+
17+
You will need to start a new shell for this setup to take effect.
18+
19+
20+
```bash
21+
devbox completion fish [flags]
22+
```
23+
24+
## Options
25+
26+
```text
27+
-h, --help help for fish
28+
--no-descriptions disable completion descriptions
29+
-q, --quiet suppresses logs
30+
```
31+
32+
## SEE ALSO
33+
34+
* [devbox completion](devbox_completion.md) - Generate the autocompletion script for the specified shell
35+
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# devbox completion zsh
2+
3+
Generate the autocompletion script for the zsh shell.
4+
5+
If shell completion is not already enabled in your environment you will need
6+
to enable it. You can execute the following once:
7+
8+
```bash
9+
echo "autoload -U compinit; compinit" >> ~/.zshrc
10+
```
11+
12+
To load completions in your current shell session:
13+
14+
```bash
15+
source <(devbox completion zsh); compdef _devbox devbox
16+
```
17+
18+
To load completions for every new session, execute once:
19+
20+
## Linux
21+
22+
```bash
23+
devbox completion zsh > "${fpath[1]}/_devbox"
24+
```
25+
26+
## macOS
27+
28+
```bash
29+
devbox completion zsh > $(brew --prefix)/share/zsh/site-functions/_devbox
30+
```
31+
32+
You will need to start a new shell for this setup to take effect.
33+
34+
35+
```text
36+
devbox completion zsh [flags]
37+
```
38+
39+
## Options
40+
41+
```text
42+
-h, --help help for zsh
43+
--no-descriptions disable completion descriptions
44+
-q, --quiet suppresses logs
45+
```
46+
47+
48+
## SEE ALSO
49+
50+
* [devbox completion](devbox_completion.md) - Generate the autocompletion script for the specified shell
51+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# devbox install
2+
3+
Start a new devbox shell and installs all packages mentioned in devbox.json in current directory ora directory specified via --config.
4+
5+
Then exits the shell when packages are done installing.
6+
7+
```bash
8+
devbox install [flags]
9+
```
10+
11+
## Options
12+
13+
```text
14+
-c, --config string path to directory containing a devbox.json config file
15+
-h, --help help for install
16+
-q, --quiet suppresses logs
17+
```
18+
19+
## SEE ALSO
20+
21+
* [devbox](devbox.md) - Instant, easy, predictable development environments
22+

docs/app/docs/cli_reference/devbox_run.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ For more details, read our [scripts guide](../guides/scripts.md)
1515
devbox run <script | command> [flags]
1616
```
1717

18+
19+
## Examples
20+
21+
```bash
22+
# Run a command directly:
23+
devbox add cowsay
24+
devbox run cowsay hello
25+
devbox run -- cowsay -d hello
26+
27+
#Run a script (defined as `"moo": "cowsay moo"`) in your devbox.json:
28+
devbox run moo
29+
```
30+
1831
## Options
1932

2033
```text
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# devbox shellenv
2+
3+
Print shell commands that add Devbox packages to your PATH
4+
5+
```bash
6+
devbox shellenv [flags]
7+
```
8+
9+
## Options
10+
11+
```text
12+
-c, --config string path to directory containing a devbox.json config file
13+
-h, --help help for shellen
14+
-q, --quiet suppresses logs``
15+
```
16+
17+
### SEE ALSO
18+
19+
* [devbox](devbox.md) - Instant, easy, predictable development environments

0 commit comments

Comments
 (0)