nushell / nushell/nushell.github.io

Most frequently used Nushell commands chapter

Open
#899 27 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
258
Forks
561
Avg merge
3h 20m
Merged PRs (30d)
15

Description

UPD: for those who are interested result are published here:
https://github.com/maxim-uvarov/nu-commands-frequency-stats/blob/main/aggregated_stats/aggregated-freq-stats20230911.csv

Work on the script is in progress


Guys, I think it would be cool to add a chapter to the book about the most frequently used Nushell commands to help newcomers prioritize their learning efforts.

To gather statistics from several nushell users, I wrote this script.

After running this script, it will produce two files: a CSV with the commands and their frequency that were used in your history for more than 10 times and a YAML-formatted txt file with some additional information (as github doesn't allow to upload files with YAML extension into the comments).

Please feel free to alter that data by either increasing the frequency threshold included in the CSV report commands or by not attaching the YAML.txt file if you believe it could somehow harm your privacy.

If you would like to contribute your data, please run the script and upload your files in this thread so we could aggregate the data from them.

The script will ask you if you want to include stats only about built-in commands or all the commands that you used. It is up to you how much information you want to share.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked history-stats2.nu script and the published aggregated-freq-stats20230911.csv results, then inspect the book's existing chapter structure. Done means adding a newcomer-oriented chapter that uses the collected command-frequency data and fits the book's documentation style.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.