Skip to content

Commit 5942d71

Browse files
authored
Updated devbox shell documentation (#2074)
## Summary - added --config flag; - added --environment flag; - removed dirs path param; ## How was it tested? Checked against the command `devbox shell -h` with the latest version. Signed-off-by: Valerio Farrotti <[email protected]>
1 parent b56b7f1 commit 5942d71

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/app/docs/cli_reference/devbox_shell.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,23 @@ Start a new shell or run a command with access to your packages
44

55
## Synopsis
66

7-
Start a new shell or run a command with access to your packages. The interactive shell will use the devbox.json in your current directory, or the directory provided with `dir`.
7+
Start a new shell or run a command with access to your packages.
8+
If the --config flag is set, the shell will be started using the devbox.json found in the --config flag directory.
9+
If --config isn't set, then devbox recursively searches the current directory and its parents.
810

911
```bash
10-
devbox shell [<dir>] [flags]
12+
devbox shell [flags]
1113
```
1214

1315
## Options
1416

1517
<!-- Markdown Table of Options -->
1618
| Option | Description |
1719
| --- | --- |
20+
| `-c, --config string`| path to directory containing a devbox.json config file |
1821
| `-e, --env stringToString` | environment variables to set in the devbox environment (default []) |
1922
| `--env-file string` | path to a file containing environment variables to set in the devbox environment |
23+
| `--environment string` | environment to use, when supported (e.g.secrets support dev, prod, preview.) (default "dev") |
2024
| `--print-env` | Print a script to setup a devbox shell environment |
2125
| `--pure` | If this flag is specified, devbox creates an isolated shell inheriting almost no variables from the current environment. A few variables, in particular HOME, USER and DISPLAY, are retained. |
2226
| `-h, --help` | help for shell |

0 commit comments

Comments
 (0)