Skip to content

docs(deactivate): add flox-deactivate man page and deactivation section #17

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.

Sign up for GitHub

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

Open
djsauble wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs(deactivate): add flox-deactivate man page and deactivation section #17

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3368c6b
docs(deactivate): add deactivation concept section and nav entry
djsauble May 20, 2026
dd74d91
docs(deactivate): add flox-deactivate man page
djsauble May 20, 2026
10ac46e
Apply suggestion from @djsauble
djsauble May 20, 2026
8308a20
docs(deactivate): drop man page and nav entry
djsauble Jun 2, 2026
590193e
docs(deactivate): revert flox-activate.mdx edits
djsauble Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions concepts/activation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ When you activate this way your existing shell is paused and you're put into a
new one configured by Flox.
Once this shell exits (via `exit` or `Ctrl-D`, for example), your original shell
is resumed and your are put back into it.
Running [`flox deactivate`](/man/flox-deactivate) inside the subshell has the
same effect.

```mermaid
%%{init: {'theme':'base','themeVariables':{'primaryColor':'#e8eef6','primaryBorderColor':'#7d96b8','primaryTextColor':'#1f2937','lineColor':'#7d96b8','noteBkgColor':'#e8eef6','noteTextColor':'#1f2937','noteBorderColor':'#7d96b8','actorBkg':'#e8eef6','actorBorder':'#7d96b8','actorTextColor':'#1f2937','actorLineColor':'#7d96b8','signalColor':'#1f2937','signalTextColor':'#1f2937','labelBoxBkgColor':'#e8eef6','labelBoxBorderColor':'#7d96b8','labelTextColor':'#1f2937','loopTextColor':'#1f2937','sequenceNumberColor':'#1f2937'},'sequence':{'mirrorActors':false}}}%%
Expand Down Expand Up @@ -358,6 +360,15 @@ If you edit your manifest and activate in a new shell,
the whole activation process is run again and subsequent activations will
attach to this new version of the environment.

## Deactivating environments

Activation is reversible.
[`flox deactivate`](/man/flox-deactivate) tears down the most recently
activated environment in your shell,
restoring the environment variables and shell customizations that activation
changed.
See [`flox deactivate`](/man/flox-deactivate) for the full command reference.

## Development vs. runtime mode

See the [`options.activate.mode`](/man/manifest.toml#options) option in the manifest.
Expand Down