search

nushell / nushell

A new type of shell
https://www.nushell.sh/
MIT License
31.72k stars 1.63k forks source link

can't find comprensive documentation of nu invocation and command-line switches #6276

Open PerBothner opened 2 years ago

PerBothner commented 2 years ago

Related problem

Is there a place where the nu command itself is documented in detail, including all the command-line switches? Something like the output of nu --help but in the form of comprehensive reference documentation, with appropriate links to other parts of the documentation,

Describe the solution you'd like

As one possible model look at at the first part of man bash, specifically these sections: OPTIONS, ARGUMENTS, INVOCATION.

It needs to be easy to find from the main page of the "Book". I suggest in the "Nu as a Shell" part.

Describe alternatives you've considered

No response

Additional context and details

No response

fdncred commented 2 years ago

Hey @PerBothner! No, there is no comprehensive documentation on parameters. Your best bet is nu --help and/or looking at the source code starting around here https://github.com/nushell/nushell/blob/fc8512be395777790bb3f3607ac3d5e9632251c6/src/main.rs#L98

You may also find some information on our documetation site at https://nushell.sh

If there's something specific you're wanting to do, you can always drop by Discord and ask.