Installing `nu_scripts` and other notes
Nobody has claimed this yet.
- Dominant language
- Nushell
- Stars
- 335
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
tl;dr Can nupm currently install nu_scripts? And if not I'd be open to implement it, some guidance would be appreciated.
I originally asked about this on the nu_scripts repo itself, which is interesting because I had already looked at nupm but I guess I'd decided that what I was looking for wasn't in scope. I think maybe it's that I couldn't tell the difference between this project being advertised as WIP and the sparse usage examples. Or in other words, in my cursory research of the various, current Nushell package manager projects, I blurred "don't expect too much from this project" with "this project doesn't do much".
But then @fdncred pointed me back here and then I noticed the "/nushell" organisation in the repo URL! So now I'm back to thinking this project will have much to offer. Would adding the definite article to the README title help, "nupm - The Nushell package manager"?
The first time I looked at this repo I did actually have a quick look at the design document, but I interpreted "design" as more like "architecture" and less like "roadmap". I've since found the old Roadmap PR where I saw that both the things I want from nupm are planned: installing nu_scripts and automatic self-installation. What about adding a concise TODO-style roadmap on the README?
Even without a roadmap on the README I'm still wondering about communicating a bit more insight into what to expect from nupm. It's basically the Cargo of Nushell right? It can both install standalone plugins and be used as a dependency manager for Nushell projects? Whilst I understand Cargo.toml I'm not quite sure what adding a plugin (or script) to my personal config will do? Is there a kind of user-based nupm.toml at ~/.config/nupm/nupm.toml?
I think at least it would be good to have some basic usage examples in the README. Like:
nupm install nufetch(a real, but lightweight example).nupm add https://github.com/nushell/nupm/blob/main/nupm.nuon. BTW I assume thatnupm.nuonis the equivalent ofCargo.toml?
Whilst it's clear that this project is WIP, it would also like some early users? Are the lack of usage examples intentional or just an oversight? I, at least, dismissed this project at first because I could neither read about its goals nor try any commands.
I'd be happy to offer PRs improving the README. And, should I have a go at trying to implement nu_scripts installation and automatic self-installation?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README, the design document, and the old Roadmap PR to understand the intended scope; inspect nupm.nuon and bootstrap/bootstrap.nu for the package and self-installation context. Done should mean the README clearly explains goals, roadmap, and basic usage examples, with any implementation work scoped separately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100