Skip to content

Commit

Permalink
Merge pull request #2205 from rsteube/doc-fix-env
Browse files Browse the repository at this point in the history
doc: fix environment
  • Loading branch information
rsteube authored Jan 30, 2024
2 parents 0df9f91 + 7f62f7d commit a0f8656
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions docs/src/setup/environment.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
# Environment

## CARAPACE_COVERDIR
## CARAPACE_BRIDGES

Which implicit bridges to enable.

- [bash](https://www.gnu.org/software/bash/)
- [fish](https://fishshell.com/)
- [inshellisense](https://github.com/microsoft/inshellisense)
- [zsh](https://www.zsh.org/)

![](./bridges.cast)

## CARAPACE_COVERDIR

Coverage directory for sandbox tests (internal).

## CARAPACE_ENV
## CARAPACE_ENV

Whether to register `get-env`, `set-env` and `unset-env` functions.

- `0` - disabled
- `1` - enabled

![](./env.cast)

## CARAPACE_EXCLUDES

Which internal completers to exclude.

![](./excludes.cast)

## CARAPACE_HIDDEN
## CARAPACE_HIDDEN

Whether to show hidden commands/flags.

Expand All @@ -22,7 +39,7 @@ Whether to show hidden commands/flags.

![](./hidden.cast)

## CARAPACE_LENIENT
## CARAPACE_LENIENT

Whether to allow unknown flags.

Expand All @@ -31,7 +48,7 @@ Whether to allow unknown flags.

![](./lenient.cast)

## CARAPACE_LOG
## CARAPACE_LOG

Whether to enable logging.

Expand All @@ -40,36 +57,19 @@ Whether to enable logging.

![](./log.cast)

## CARAPACE_MATCH
## CARAPACE_MATCH

Whether to match case insensitive.

- `0` - disabled
- `1` - enabled
- `0` - case sensitive
- `1` - case insensitive

![](./match.cast)

## CARAPACE_SANDBOX
## CARAPACE_SANDBOX

Mock context for sandbox tests (internal).

## CARAPACE_ZSH_HASH_DIRS
## CARAPACE_ZSH_HASH_DIRS

Zsh hash directories (internal).

## CARAPACE_EXCLUDES

Which internal completers to exclude.

![](./excludes.cast)

## CARAPACE_BRIDGES

Which implicit bridges to enable.

- [bash](https://www.gnu.org/software/bash/)
- [fish](https://fishshell.com/)
- [inshellisense](https://github.com/microsoft/inshellisense)
- [zsh](https://www.zsh.org/)

![](./bridges.cast)

0 comments on commit a0f8656

Please sign in to comment.