holm/nushell
1
1
Fork 0
forked from extern/nushell
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add in a Readme for the crate nu-cmd-extra (#9745)

Browse Source 
This outlines our plans for the commands located in the crate
nu-cmd-extra.

It also documents how one can build these commands from source.
This commit is contained in:
Michael Angerman 2023-07-19 21:35:58 -07:00 committed by GitHub
parent 2d557bce5d
commit 5115260366
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
crates/nu-cmd-extra/README.md Normal file
View File

@ -0,0 +1,30 @@
# nu-cmd-extra
## the extra commands are not part of the Nushell binary
The commands in this crate are the *extra commands* of Nushell. They do not
get built for the release and it is the responsibility of the developer to
build these commands if they want to use them.
These commands are not going to part of the 1.0 Api; meaning that there
is no guarantee longer term that these commands will be around into the future.
Of course since they are part of the source tree one could always incorporate
them into their own custom release.
### How to build the commands in this crate
Step 1 is to
[read the installation notes](https://www.nushell.sh/book/installation.html#build-from-source)
for Nushell which is located in our Nushell book.
Once Rust is installed you can then build Nushell with the following command.
```rust
cargo build --features=extra
```
Your Nushell binary which just got built is called *nu* and will be located here.
```
nushell/target/debug/nu
```