One small docs suggestion:
The global npm install itself makes sense for a CLI like this, so I am not suggesting changing that.
The issue is more about the surrounding environment. On Linux and macOS, users with a system-wide Node/npm setup can run into permissions problems with global npm installs, which often leads people to use sudo npm install -g .... That usually works in the moment, but it is not a great workflow and can create avoidable permission issues later.
It may help to add a short note recommending nvm or fnm for the install process, or at least mentioning that a user-level Node setup is the safer option for global CLI tools.
So this is really just a small documentation improvement: keep the global install, but reduce friction for users whose npm setup is not isolated in their home directory.
One small docs suggestion:
The global npm install itself makes sense for a CLI like this, so I am not suggesting changing that.
The issue is more about the surrounding environment. On Linux and macOS, users with a system-wide Node/npm setup can run into permissions problems with global npm installs, which often leads people to use
sudo npm install -g .... That usually works in the moment, but it is not a great workflow and can create avoidable permission issues later.It may help to add a short note recommending
nvmorfnmfor the install process, or at least mentioning that a user-level Node setup is the safer option for global CLI tools.So this is really just a small documentation improvement: keep the global install, but reduce friction for users whose npm setup is not isolated in their home directory.