-
Notifications
You must be signed in to change notification settings - Fork 269
Update docs to use versions + Global commands #1068
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,4 +23,4 @@ | |
"nixpkgs": { | ||
"commit": "3364b5b117f65fe1ce65a3cdd5612a078a3b31e3" | ||
} | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# devbox create | ||
|
||
Initialize a directory as a devbox project using a template | ||
|
||
## Synopsis | ||
|
||
Initialize a directory as a devbox project. This will create an empty devbox.json in the current directory. You can then add packages using `devbox add` | ||
|
||
```bash | ||
devbox create [dir] --template <template> [flags] | ||
``` | ||
|
||
## List of templates | ||
|
||
* [**go**](https://github.com/jetpack-io/devbox/tree/main/examples/development/go) | ||
* [**node-npm**](https://github.com/jetpack-io/devbox/tree/main/examples/development/nodejs/nodejs-npm/) | ||
* [**node-typescript**](https://github.com/jetpack-io/devbox/tree/main/examples/development/nodejs/nodejs-typescript/) | ||
* [**node-yarn**](https://github.com/jetpack-io/devbox/tree/main/examples/development/nodejs/nodejs-yarn/) | ||
* [**php**](https://github.com/jetpack-io/devbox/tree/main/examples/development/php/) | ||
* [**python-pip**](https://github.com/jetpack-io/devbox/tree/main/examples/development/python/pip/) | ||
* [**python-pipenv**](https://github.com/jetpack-io/devbox/tree/main/examples/development/python/pipenv/) | ||
* [**python-poetry**](https://github.com/jetpack-io/devbox/tree/main/examples/development/python/poetry/) | ||
* [**ruby**](https://github.com/jetpack-io/devbox/tree/main/examples/development/ruby/) | ||
* [**rust**](https://github.com/jetpack-io/devbox/tree/main/examples/development/rust/) | ||
|
||
|
||
## Options | ||
|
||
<!--Markdown Table of Options --> | ||
| Option | Description | | ||
| --- | --- | | ||
| `-h, --help` | help for init | | ||
| `-t, --template string` | Template to use for the project. | ||
| `-q, --quiet` | Quiet mode: Suppresses logs. | | ||
|
||
## SEE ALSO | ||
|
||
* [devbox](./devbox.md) - Instant, easy, predictable shells and containers | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# devbox global install | ||
|
||
Install all packages mentioned in your global devbox.json. | ||
|
||
```bash | ||
devbox global install <pkg>... [flags] | ||
``` | ||
|
||
## Options | ||
|
||
<!-- Markdown Table of Options --> | ||
| Option | Description | | ||
| --- | --- | | ||
| `-h, --help` | help for global install | | ||
| `-q, --quiet` | suppresses logs | | ||
|
||
## SEE ALSO | ||
|
||
* [devbox global](devbox_global.md) - Manages global Devbox packages |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# devbox global run | ||
|
||
Starts a new shell and runs your script or command in it, exiting when done. | ||
|
||
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 example) | ||
|
||
```bash | ||
devbox global run <pkg>... [flags] | ||
``` | ||
|
||
## Examples | ||
|
||
Run a command directly: | ||
|
||
```bash | ||
devbox add cowsay | ||
devbox global run cowsay hello | ||
devbox global run -- cowsay -d hello | ||
``` | ||
|
||
Run a script (defined as `"moo": "cowsay moo"`) in your devbox.json: | ||
|
||
```bash | ||
devbox global run moo | ||
``` | ||
|
||
## Options | ||
|
||
<!-- Markdown Table of Options --> | ||
| Option | Description | | ||
| --- | --- | | ||
| `-h, --help` | help for global run | | ||
| `-q, --quiet` | suppresses logs | | ||
|
||
## SEE ALSO | ||
|
||
* [devbox global](devbox_global.md) - Manages global Devbox packages |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# devbox global services | ||
|
||
Interact with Devbox services for your global packages. This command replicates the subcommands for [devbox services](devbox_services.md) but for your global packages. | ||
|
||
```bash | ||
devbox global services [command] | ||
``` | ||
|
||
## Options | ||
|
||
<!-- Markdown Table of Options --> | ||
| Option | Description | | ||
| --- | --- | | ||
| `-h, --help` | help for global services | | ||
| `-q, --quiet` | suppresses logs | | ||
|
||
## SEE ALSO | ||
|
||
* [devbox global](devbox_global.md) - Manages global Devbox packages |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# devbox global update | ||
|
||
Updates packages in your Devbox global config to the latest available version. | ||
|
||
## Synopsis | ||
|
||
If you provide this command with a list of packages, it will update those packages to the latest available version based on the version tag provided. | ||
|
||
For example: if your global config has `python@3.11` in your package list, running `devbox update` will update to the latest patch version of `python 3.11`. | ||
|
||
If no packages are provided, this command will update all the versioned packages to the latest acceptable version. | ||
|
||
```bash | ||
devbox update [pkg]... [flags] | ||
``` | ||
|
||
## Options | ||
|
||
<!-- Markdown Table of Options --> | ||
| Option | Description | | ||
| --- | --- | | ||
| `-h, --help` | help for update | | ||
| `-q, --quiet` | suppresses logs | | ||
|
||
## SEE ALSO | ||
|
||
* [devbox global](devbox_global.md) - Manages global Devbox packages |
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
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.