Skip to content

Missing documentation content #500

@th-schall

Description

@th-schall

I have discovered nu shell some weeks ago and have switched quickly so that it is now my standard shell on Windows and the default profile in Windows Terminal. However, there are some issues I perceive with the documentation. Maybe some or all are to blame to the fact that I am not that familiar with nu shell and its documentation yet. I present all topics anyway, so that this maybe can be resolved by just providing some remark or link.

  1. I assume there are functionalites present in nu shell about which I have not found out anything yet. I cannot tell how to use this at the moment:
  • database queries with parameters to make them reusable in a safe and standardized way like SQLite supports it
  • interval formatting basically just like datetime formatting
  1. A cheat sheet type page which is a command listing/reference organized by topic/usage area. I attached a Markdown link list sketching the idea. I use this link list for myself regularly.
    nu Shell Cheat Sheet.md

  2. A scripting guide showing best practies and how to create complete non-trivial working scripts using specific tasks like these (among others):

  • iterating a table and using the values in an internal or external command
  • best practice way to write a readable table definitions with non-minimal data contents
  • persisting (configuration) data: reading and writing useful content to text/json/xml files etc.
  • best practice for using script parameters and their validation etc., like: should I check the existence of a path inside the main command block or outside?
  • best practices for multi-step file and folder operations: creating a folder with a dynamic name and then creating files with dynamic content and name in the new folder etc.
  • datetime arithmetics with datetimes alone, but also with datetimes and intervals for questions like five days before or how long between two timestamps etc.
  • script logging best practices incl. tee-ing the log lines, maybe based on records

I figure the cookbook wants to address questions like these to some degree, but for my way of thinking the solutions there are too small, isolated without a context of using them in a script. I would look for something more comprehensive. For illustration I attached the very first two scripts I wrote for nu shell as a zip file.
script.zip

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions