Skip to content

/ nushell

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for Nu commands (NO programming experience needed) #711

Open
andrasio opened this issue Sep 25, 2019 · 30 comments
Open

Documentation for Nu commands (NO programming experience needed) #711

andrasio opened this issue Sep 25, 2019 · 30 comments
Labels
documentation good first issue help wanted meta-issue

Comments

@andrasio
Copy link
Member

@andrasio andrasio commented Sep 25, 2019 •
edited by jonathandturner

We need documentation for the following Nu internal commands in any speaking language of your choosing:

If interest in working on a command, please read this first.

Please note: These are Nu commands, they may be the same name as commands you might be familiar from other shells but their usage, flags, and functionality might be different. Please make sure you have latest Nu installation 0.4.0 (you can confirm this by running the version command under Nu).

You can learn more about how a Nu command works by looking at the source code or from Nu itself running help command where command is the command you are interested in documenting.

VERY IMPORTANT you try and experiment with the command using Nu to get ideas.

  • compact
  • default
  • histogram
  • split-by
  • prepend
  • append
  • group-by
  • average
  • embed
  • str
  • inc
  • skip
  • sys
  • ps
  • tree
  • binaryview
  • docker
  • match
  • cd
  • clip
  • config
  • count
  • date
  • echo
  • enter
  • env
  • exit
  • fetch
  • first
  • format
  • from_bson
  • from_csv
  • from_ini
  • from_json
  • from_sqlite
  • from_ssv
  • from_toml
  • from_tsv
  • from_url
  • from_xlsx
  • from_xml
  • from_yaml
  • get
  • help
  • last
  • lines
  • nth
  • open
  • pick
  • pivot
  • post
  • reject
  • reverse
  • save
  • shells
  • size
  • skip_while
  • sort_by
  • split_column
  • split_row
  • tags
  • to_bson
  • to_csv
  • to_json
  • to_sqlite
  • to_toml
  • to_tsv
  • to_url
  • to_yaml
  • trim
  • version
  • where
  • which
  • sum
  • add
  • edit
@marcelocg
Copy link
Contributor

@marcelocg marcelocg commented Oct 1, 2019

I'm picking date
@nalshihabi nalshihabi mentioned this issue Oct 1, 2019
Merged
@yahsinhuangtw
Copy link
Contributor

@yahsinhuangtw yahsinhuangtw commented Oct 1, 2019

I'm picking help
@coolshaurya coolshaurya mentioned this issue Oct 1, 2019
Merged
@yahsinhuangtw yahsinhuangtw mentioned this issue Oct 1, 2019
Merged
@andrasio andrasio added the meta-issue label Oct 1, 2019
@notryanb
Copy link
Contributor

@notryanb notryanb commented Oct 1, 2019 •
edited

I'll grab first if that's okay. What about documenting plugins that are included in help <command name> like sum?
@jonathandturner
Copy link
Collaborator

@jonathandturner jonathandturner commented Oct 1, 2019

@notryanb - those would be good to document, too
@akramkazmi71 akramkazmi71 mentioned this issue Oct 2, 2019
Closed
@akramkazmi71
Copy link

@akramkazmi71 akramkazmi71 commented Oct 2, 2019

I would like to provide document for tree command
This was referenced Oct 2, 2019
Merged
Closed
Merged
Merged
@CDRayn
Copy link

@CDRayn CDRayn commented Oct 2, 2019

If no one minds. I'd like to work on documenting the which command.
@codingonHP
Copy link

@codingonHP codingonHP commented Oct 2, 2019

Can I take clip command.
@andrasio
Copy link
Member Author

@andrasio andrasio commented Oct 2, 2019

@CDRayn go ahead!
@andrasio
Copy link
Member Author

@andrasio andrasio commented Oct 2, 2019

@codingonHP no problem!
@andrasio
Copy link
Member Author

@andrasio andrasio commented Oct 2, 2019

@akramkazmi71 thanks!
codingonHP added a commit to codingonHP/nushell that referenced this issue Oct 2, 2019
@codingonHP
[Issue nushell#711] Documentation for Nu commands
883bbe0 
Add documentation for `clip` command
@notryanb notryanb mentioned this issue Oct 2, 2019
Merged
This was referenced Oct 2, 2019
Closed
Closed
Closed
@gilesv
Copy link
Contributor

@gilesv gilesv commented Oct 3, 2019

I'm picking where.
@gilesv gilesv mentioned this issue Oct 3, 2019
Merged
@garrettqmartin8
Copy link

@garrettqmartin8 garrettqmartin8 commented Oct 3, 2019

I'll pick up ps
oknozor added a commit to oknozor/nushell that referenced this issue Oct 25, 2019
@oknozor
Create docs for from-toml command
21eee63 
Partial fix of issue nushell#711
oknozor added a commit to oknozor/nushell that referenced this issue Oct 25, 2019
@oknozor
Create docs for from-toml command
07ceec3 
Partial fix of issue nushell#711
@oknozor oknozor mentioned this issue Oct 25, 2019
Merged
@oknozor
Copy link
Contributor

@oknozor oknozor commented Oct 25, 2019

Sorry it seems I messed up referencing the issue.
I did from-toml to by the way.
@coderkalyan
Copy link

@coderkalyan coderkalyan commented Oct 29, 2019

I'll try from_json!
@loksonarius
Copy link

@loksonarius loksonarius commented Nov 1, 2019

Nabbing tags real quick
@loksonarius loksonarius mentioned this issue Nov 1, 2019
Merged
@andrasio
Copy link
Member Author

@andrasio andrasio commented Nov 3, 2019

#900
@andrasio andrasio removed the hacktoberfest label Nov 3, 2019
coolshaurya added a commit to coolshaurya/nushell that referenced this issue Nov 10, 2019
@coolshaurya
Add docs for the count command
50616cc 
Partial fix of issue nushell#711
This was referenced Nov 10, 2019
Merged
Merged
rtlechow added a commit to rtlechow/nushell that referenced this issue Nov 14, 2019
@rtlechow
Document pivot command
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
0368607 
Part of nushell#711
rtlechow added a commit to rtlechow/nushell that referenced this issue Nov 14, 2019
@rtlechow
Document pivot command
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
c6a7d89 
Part of nushell#711
@rtlechow rtlechow mentioned this issue Nov 14, 2019
Merged
This was referenced Nov 15, 2019
Merged
Merged
Merged
@sebastian-xyz sebastian-xyz mentioned this issue Nov 30, 2019
Merged
@tchak
Copy link
Contributor

@tchak tchak commented Nov 30, 2019

I am working on compact and default. It seems they are not in the list.
@andrasio
Copy link
Member Author

@andrasio andrasio commented Dec 1, 2019 •
edited

@tchak > I am working on compact and default. It seems they are not in the list.

Thanks! In the list now.
This was referenced Jan 25, 2020
Merged
Merged
@coolshaurya coolshaurya mentioned this issue Feb 29, 2020
Merged
@pulpdrew
Copy link
Contributor

@pulpdrew pulpdrew commented Mar 18, 2020

I've got skip and skip-while
@pulpdrew pulpdrew mentioned this issue Mar 18, 2020
Merged
@thegedge
Copy link
Collaborator

@thegedge thegedge commented Mar 18, 2020

❤️ to you all helping us out with documentation
@pulpdrew pulpdrew mentioned this issue Mar 20, 2020
Merged
@nespera nespera mentioned this issue May 3, 2020
Merged
@jzaefferer
Copy link
Contributor

@jzaefferer jzaefferer commented May 17, 2020

comparing docs/commands/ and crates/nu-cli/src/commands/, these 32 commands are still missing docs:

autoview,binaryview,clear,cp,describe,drop,each,empty?,keep,keep-until,keep-while,kill,match,merge,mkdir,mv,n,p,parse,post,pwd,range,rm,run_external,shuffle,skip-until,split-by,table,textview,touch,tree,with-env

Some to and from subcommands as well as plugins are probably missing, too; haven't checked those.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue help wanted meta-issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
You can’t perform that action at this time.