Skip to content

Commit

Permalink
docs(proto): Clarify PATH requirement for proto binary
Browse files Browse the repository at this point in the history
  • Loading branch information
liby committed Nov 29, 2024
1 parent dedbffd commit 1e5c274
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions website/docs/proto/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ $ which node
To make use of shims, prepend the `~/.proto/shims` directory to `PATH` in your shell profile. This
_must come before_ the [bin directory](#binary-linking) if using both.

If you're using or plan to use [shell activation](#shell-activation), this happens automatically and
can be ignored.
If you're using or plan to use [shell activation](#shell-activation), the `PATH` configuration
happens automatically, but shell activation will only work if the `proto` command is accessible,
which requires `~/.proto/bin` to be in your `PATH`.

## Binary linking

Expand Down Expand Up @@ -83,8 +84,9 @@ Node.js package managers currently do not support this, as JavaScript files are
To make use of bins, prepend the `~/.proto/bin` directory to `PATH` in your shell profile. This
_must come after_ the [shim directory](#shims) if using both.

If you're using or plan to use [shell activation](#shell-activation), this happens automatically and
can be ignored.
If you're using or plan to use [shell activation](#shell-activation), the `PATH` configuration
happens automatically, but shell activation will only work if the `proto` command is accessible,
which requires `~/.proto/bin` to be in your `PATH`.

## Shell activation<VersionLabel version="0.38.0" />

Expand Down

0 comments on commit 1e5c274

Please sign in to comment.