search

MatrixAI / Polykey-Docs

Documentation for Polykey
https://polykey.com/docs/
GNU General Public License v3.0
1 stars 5 forks source link

Explain how to setup PATH during installation of Polykey #64

Open sujaycarkey opened 4 months ago

sujaycarkey commented 4 months ago

Procedural Documentation Tasks

Comment: This should be less of an issue now since we are also providing the npm install method which should bypass many of the PATH related configuration complications use can experience. However, even for this method, there's configuration requirements for npm that users must have already setup for the global install method to be seamless.

Describe the bug

While following the guide for installing Polykey on Bash terminal, I was running into an issue with @CryptoTotalWar where the path wasn't being found for the install, leading to the executable not being able to be started just by typing 'polykey' into the terminal.

To Reproduce

  1. ...
  2. ...
  3. ...

Expected behavior

Polykey should be added as a path, then should be able to be used as a command in the terminal.

Screenshots

image

image

Platform (please complete the following information)

Additional context

Problem was fixed once I edited the path command to this instead of what was there: echo 'export PATH=\~/downloads/polykey:$PATH' >> \~/.bashrc && source \~/.bashrc

Notify maintainers

linear[bot] commented 4 months ago

ENG-323 Pathing Issue with Polykey Install Guide

CMCDragonkai commented 4 months ago

Hi @sujaycarkey PK CLI will not add itself to the PATH as that's a user configuration of the operating system and not an application concern. This might be better explained in the docs. Perhaps @CryptoTotalWar can move to the docs.

In the future we may have some "installer" script that can be run.

linear[bot] commented 3 months ago

PRO-183 Pathing Issue with Polykey Install Guide

CMCDragonkai commented 3 months ago

Nix has a script installer - we could replicate this for different OSes, but users are recommended to read the script for installation of the CLI. However for non-technical users, it would have to be distributed through their app-distribution systems, like Mac App Store, or Windows system or OS package manager.

Creating a custom installer for a CLI tool seems overkill.

CMCDragonkai commented 3 months ago

I would argue this issue can be solved with more documentation, and later we can scope out installer/scripts in the engineering team.