Skip to content

docs(run): document that scripts and commands run from the project root #2948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mikeland73 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Open

docs(run): document that scripts and commands run from the project root #2948

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion internal/boxcli/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ func runCmd(defaults runFlagDefaults) *cobra.Command {
Long: "Start a new shell and runs your script or command in it, exiting when done.\n\n" +
"The script must be defined in `devbox.json`, or else it will be interpreted as an " +
"arbitrary command. You can pass arguments to your script or command. Everything " +
"after `--` will be passed verbatim into your command (see examples).\n\n",
"after `--` will be passed verbatim into your command (see examples).\n\n" +
"Scripts and commands always run from the project's root directory (the directory " +
"containing your `devbox.json`), not the current working directory. If you invoke " +
"`devbox run` from a subdirectory and need to run there, change into it as part of " +
"your command, e.g. `devbox run -- sh -c 'cd subdir && <command>'`.\n\n",
Example: "\nRun a command directly:\n\n devbox add cowsay\n devbox run cowsay hello\n " +
"devbox run -- cowsay -d hello\n\nRun a script (defined as `\"moo\": \"cowsay moo\"`) " +
"in your devbox.json:\n\n devbox run moo",
Expand Down
Loading