Skip to main content

envy shell

Print the line to add to your shell profile to enable shell hooks, which manage PATH per project as you cd around.

This command does not create the hook file. envy maintains it in the user-wide cache during self-deploy, so any earlier envy command has already put it there. shell finds the one for your shell and prints how to source it. The hook is pure shell: no envy process runs on cd, and it updates itself across envy versions.

The hook root is --cache-root or ENVY_CACHE_ROOT if set, otherwise the platform default. No project setting moves it, and a project on its own cache tree writes no hooks at all. See Shell Hooks.

Usage​

envy shell <bash|zsh|fish|powershell>

Arguments​

ArgumentMeaning
shellOne of bash, zsh, fish, powershell. Required. Anything else is rejected with the list.

Output is instructions on stderr, naming the profile file and the line to add. It is not a bare line for redirection, so copy it rather than appending the command's output to your profile. The path uses $HOME, or PowerShell's ${env:...} syntax, so it stays portable across machines.

If the hook file is missing, shell says so. On a normal project that means running any envy command, which triggers self-deploy. On a project using its own cache tree it means running one in a project on the user-wide cache, or setting ENVY_CACHE_ROOT, because a local tree never populates hooks. shell also names a stale project-local shell/ directory an older envy left behind, so you can delete it once your profile points at the real one.

Examples​

To enable automatic project activation in your shell​

envy shell zsh
# Add this line to ~/.zshrc:
#
#   source "$HOME/Library/Caches/envy/shell/hook.zsh"
#
# Then restart your shell or run the command directly.

Paste that line into ~/.zshrc, restart, and cd into any envy project. Its tools are on PATH, with a 🦝 marker in the prompt. cd out and they are gone.

To set up the other supported shells​

envy shell bash          # ~/.bashrc
envy shell fish          # ~/.config/fish/config.fish

On Windows, PowerShell gets a dot-source line for $PROFILE, pointing at the .ps1 hook in %LOCALAPPDATA%\envy:

envy shell powershell
# Add this line to $PROFILE:
#
#   . "${env:USERPROFILE}/AppData/Local/envy/shell/hook.ps1"
#
# Then restart your shell or run the command directly.

The ${env:...} form is native PowerShell syntax, so the line stays valid on any machine regardless of where the profile directory lives.

To find the hook path when your cache is not in the default place​

envy --cache-root /opt/envy-cache shell zsh

The printed path points into whichever user-wide cache root is in effect. Only an override earns the warning that moving or deleting that cache breaks shell integration, because the platform default is not somewhere you lose by accident.

envy cache --user-wide-root prints the same root without the surrounding instructions:

ls "$(envy cache --user-wide-root)/shell"

See also​