Docs: Clarify Linux PATH setup for manual Polykey installation #150
Conversation
|
@aryanjassal Hey, can you review my changes and let me know what you think? |
| 3. Add the executable to your PATH | ||
|
|
||
| To run `polykey` from anywhere, you need to add the directory containing it to | ||
| your `PATH`. You can either: | ||
|
|
||
| - Move `polykey` into an existing directory already in your `PATH` (e.g., | ||
| `/usr/local/bin`), **or** | ||
| - Add the current directory to your `PATH`, either temporarily or permanently: | ||
|
|
||
| **Temporary (until terminal closes):** | ||
|
|
||
| ````sh | ||
| export PATH="$PWD:$PATH" | ||
|
|
||
| 4. Confirm the installation: | ||
|
|
||
| ```sh | ||
| polykey --version | ||
| ``` | ||
| ```` |
There was a problem hiding this comment.
Adding polykey into $PATH depends on the operating system.
On Linux, people usually use package managers. If they are doing this manually, then they should put polykey into ~/.local/bin.
MacOS also the same ~/.local/bin.
On Windows, put it in %USERPROFILE%\AppData\Local\Microsoft\WindowsApps.
Note that if you asked this question to chatgpt it would have explained this:
As of 2025, for MacOS, what is considered the most common/official/best practice when downloading an executable from the internet and putting it into a location where it can be accessed with $PATH? Ideally user-profile specific.
Putting in a particular location also requires creating that directory using mkdir -p.
In windows, that directory already exists and is already on the PATH.
On Linux/MacOS, the PATH has to be manually updated by updating their preferred shell configuration. This is usually ~/.zshrc in MacOS, but on Linux, many possibilities.
I think you generally need to elaborate on this.
| @@ -83,16 +93,18 @@ a terminal to restart it. | |||
| - For ZSH: | |||
|
|
|||
| ```shell | |||
| export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc | |||
| export PATH="$HOME/Downloads:$PATH"' >> ~/.zshrc && source ~/.zshrc | |||
There was a problem hiding this comment.
There's a syntax violation here. You cannot use "'.
Double quote is necessary for interpolating variables. Single quote cannot be used. Remove the single quote here.
There was a problem hiding this comment.
Wait a minute I think I got confused here cause there's no echo command here.
See the bash script below. You're missing the echo.
| ```shell | ||
| export PATH=~/Downloads:$PATH >> ~/.bashrc && source ~/.bashrc && source | ||
| echo 'export PATH="$HOME/Downloads:$PATH"' >> ~/.bashrc && source ~/.bashrc |
There was a problem hiding this comment.
The single quote here is correct due to the echo.
Beware about this, make sure to write these docs critically.
Also I wish you to try these commands when you write these docs, don't write docs blindly, ALWAYS SANITY CHECK.
Description
his PR updates the Linux manual installation section to clarify how to correctly and persistently add the Polykey CLI binary to the user's
$PATH. It addresses a common setup error where the CLI was not recognized due to misconfigured export syntax or non-permanent changes.Issues Fixed
Tasks
export PATH=...commands withecho '...' >> ~/.bashrcwhich polykeyverification stepFinal checklist