search

near / near-cli

General purpose command line tools for interacting with NEAR Protocol
https://docs.near.org
MIT License
193 stars 92 forks source link

feat: Add detailed instructions for installing near-cli #1099

Closed jancionear closed 4 months ago

jancionear commented 4 months ago

The installation guide in README.md provides a brief explanation of how to install the tool, but it isn't as detailed as it could be. For someone who isn't familiar with the javascript ecosystem the whole thing is pretty confusing - why nvm? Can I just do apt install npm? Why not? It took me some time before I found a sequence of instructions that worked. And users also run into problems

It would be great to have a detailed step-by-step instruction on how to install near-cli. So this PR adds the exact list of steps needed to install near-cli on Ubuntu 20.04 LTS.

gagdiez commented 4 months ago

hi @jancionear , thanks for the suggestion!

Do you think it is better to explain how to use nvm to install node or how to install node by downloading the binaries and use them? The first option is easier, the second is more universal across distros

jancionear commented 4 months ago

hi @jancionear , thanks for the suggestion!

Do you think it is better to explain how to use nvm to install node or how to install node by downloading the binaries and use them? The first option is easier, the second is more universal across distros

As a linux developer I like the nvm route more - it's a one liner that I can just paste into bash. The binary route seems more complex, I'd have to download the binaries, extract them somewhere, probably add to path...

Ideally it would be great to be able to install the tool with a single line - npm install near-cli and done. Most python tools can be installed with a single pip install, but I don't know if that's possible with javascript. Maybe a flatpak package? x.x

But as long as I can just paste some commands into the terminal without thinking too much and get the tool working reliably, I'm happy.

jancionear commented 4 months ago

Another user just installed near-cli incorrectly: https://t.me/near_stake_wars/976

Could we merge those detailed instructions?