RGBCube/nu_scripts
1
Fork 0
mirror of https://github.com/RGBCube/nu_scripts synced 2025-07-31 14:17:45 +00:00
Code Issues Activity

Added std-rfc README with installation instructions (#1030)

Browse source 
Includes a `README.md` for the `std-rfc` modules with 
information on how to checkout *just* `std-rfc` from the repo.
This commit is contained in:
Douglas 2025-01-31 22:19:04 -05:00 • committed by GitHub
parent bab7845ed4
commit 32baeb7995
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
stdlib-candidate/std-rfc/README.md Normal file
View file

@ -0,0 +1,33 @@
`std-rfc` is the root directory for modules and commands under consideration for the Nushell [Standard Library](https://www.nushell.sh/book/standard_library.html).
As a part of the the larger nu_scripts mono-repo, users may find it more convenient (and efficient) to checkout `std-rfc` separately.
This can be done in Nushell using:
```nushell
let spec = {
repo: 'https://github.com/nushell/nu_scripts'
sparse_dir: 'stdlib-candidate/std-rfc'
branch: 'main'
}
# Change to the parent directory location before running
let install_dir = './nu_scripts'
mkdir $install_dir
git -C $install_dir init
git -C $install_dir remote add origin $spec.repo
git -C $install_dir sparse-checkout set --no-cone --sparse-index $spec.sparse_dir
git -C $install_dir fetch --depth 1 --filter=blob:none origin $spec.branch
git -C $install_dir checkout $spec.branch
```
Then imported using:
```nushell
use ./nu_scripts/stdlib-candidate/std-rfc/<module>
# or
use ./nu_scripts/stdlib-candidate/std-rfc/<module> *
```
A sparse git checkout like the one above requires the full parent path from the repository, but you can symlink the `std-rfc` directory to a more convenient location if you prefer.