os/doc/api-reference-devshell.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

60 lines
1 KiB
Markdown
Raw Normal View History

# Devshell API Container
2023-01-28 20:49:10 +00:00
Configure your devshell module collections of your environment.
## devshell
2023-01-28 20:49:10 +00:00
Modules to include in your DevOS shell. the `modules` argument
will be exported under the `devshellModules` output
2023-01-28 20:49:10 +00:00
_*Type*_:
submodule or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
{}
```
## devshell.exportedModules
2023-01-28 20:49:10 +00:00
modules to include in all hosts and export to devshellModules output
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid module or path convertible to its or anything convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```
## devshell.externalModules
2023-01-28 20:49:10 +00:00
The `externalModules` option has been removed.
Any modules that should be exported should be defined with the `exportedModules`
option and all other modules should just go into the `modules` option.
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid modules or anything convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```
## devshell.modules
2023-01-28 20:49:10 +00:00
modules to include that won't be exported
meant importing modules from external flakes
2023-01-28 20:49:10 +00:00
_*Type*_:
list of valid modules or anything convertible to it or path convertible to it
2023-01-28 20:49:10 +00:00
_*Default*_
```
[]
```