docs(run): document that scripts and commands run from the project root - #2948
Open
mikeland73 wants to merge 1 commit into
Open
docs(run): document that scripts and commands run from the project root#2948mikeland73 wants to merge 1 commit into
mikeland73 wants to merge 1 commit into
Conversation
`devbox run` always executes from the directory containing devbox.json (cmd.Dir is set to the project dir in nix.RunScript), regardless of the subdirectory the command is invoked from. This surprises users who expect the current working directory to be respected, as reported in #2559. A maintainer confirmed the behavior is intentional so that a command run via `devbox run -- <cmd>` behaves consistently with a script defined in devbox.json. The reporter's follow-up ask was simply to surface this in the command help. Add a short paragraph to the `devbox run` long help explaining the working-directory behavior and how to run from a subdirectory. Closes #2559
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
devbox runalways executes from the project's root directory — the directorycontaining
devbox.json— regardless of the subdirectory it was invoked from.This is enforced in
nix.RunScript, which setscmd.Dir = projectDir(
internal/nix/run.go). Users invokingdevbox runfrom a subdirectory aresurprised that
pwdand relative paths resolve against the project root ratherthan the current working directory, as reported in #2559.
A maintainer confirmed on the issue that this is intentional: it keeps a command
run via
devbox run -- <cmd>consistent with a script defined indevbox.json,which should always run from the same place. The reporter's remaining ask was
simply that this behavior be surfaced in the command's help.
This PR adds a short paragraph to the
devbox runlong help explaining thatscripts and commands run from the project root and showing how to run from a
subdirectory when needed:
No behavior changes — documentation only.
Closes #2559
cc @alezkv (issue reporter) — thanks for raising this.
How was it tested?
go build ./internal/boxcli/andgofmt -l internal/boxcli/run.goare clean.devbox run --helpand confirmed the new paragraph renders correctly inthe long description, above the usage/examples output.
Community Contribution License
All community contributions in this pull request are licensed to the project
maintainers under the terms of the
Apache 2 License.
By creating this pull request, I represent that I have the right to license the
contributions to the project maintainers under the Apache 2 License as stated in
the
Community Contribution License.
Generated by Claude Code