diff options
| author | oyanoya <55138489+oyanoya@users.noreply.github.com> | 2022-04-03 15:33:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-03 15:33:14 +0200 |
| commit | 3014284e952f75deae87973cbe2763b7a0a0aab5 (patch) | |
| tree | 13d08c7a6239b3d2deca109b35d00c903127983d /docs/config | |
| parent | c89c13038a34a52291d253e6d4b15c0dd4aa5dfa (diff) | |
feat(spack): Add `Spack` module (#3639)
* feat/add readme + presets
* feat/add spack module
* feat/add spack config
* feat/spack to handle
* feat/add spack to modules and root
* fix/readme formattign
* fix/readme typo
* fix/readme formatting
* feat/replace module_config_derive with serde
* feat/add macros to generate schema + schema
Diffstat (limited to 'docs/config')
| -rw-r--r-- | docs/config/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index ea0ced6ea..0dec040be 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -247,6 +247,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -3167,6 +3168,39 @@ and `$SINGULARITY_NAME` is set. format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status The `status` module displays the exit code of the previous command. |