click icon indicating copy to clipboard operation
click copied to clipboard

Introduction to the command line tutorial

Open Rowlando13 opened this issue 3 months ago • 11 comments

Developers coming to Click docs may or may not have command line experience. The command line is a big subject with a lot of cross platform differences. A tutorial which targets basic things you can do would be very helpful. The goal is the minimal amount to get started.

Requirements

  • Written in myst
  • uses Diataxis principles
  • Uses docs tabs so can eventually add multiple oses and shells
  • roughly 15 minutes for user to complete tutorial
  • shows getting operating system information, directory vs file, file path, moving around, making a directory, making a file, editing a file, printing file contents to the terminal, greping something, showing help for a cli
  • good quality links to deeper information on the subject

Rowlando13 avatar Sep 21 '25 18:09 Rowlando13

Hi @Rowlando13, can I do this?

Veebaa avatar Sep 26 '25 11:09 Veebaa

Sure!

Rowlando13 avatar Sep 26 '25 14:09 Rowlando13

Hello @Rowlando13 , I will like this issue to be assigned to me I think I can come up with a good tutorial meeting the above requirements Thank you

HanslettTheDev avatar Nov 25 '25 13:11 HanslettTheDev

@Veebaa Have you made any progress on this? If @Veebaa does not respond in a week or 2, then you can have it.

Rowlando13 avatar Nov 26 '25 07:11 Rowlando13

Ok got it

HanslettTheDev avatar Nov 26 '25 13:11 HanslettTheDev

@Rowlando13, Hey, I started a document, but got busy and havent had time to review or edit 🙈 . Shall I upload and @HanslettTheDev can then contribute also?

Veebaa avatar Nov 26 '25 14:11 Veebaa

Sure!

Rowlando13 avatar Nov 26 '25 17:11 Rowlando13

@Rowlando13 Cool, I will put it under docs. Let me know if you want me to move it elsewhere.

Veebaa avatar Nov 27 '25 12:11 Veebaa

@Rowlando13 Can I continue working on his PR?

HanslettTheDev avatar Nov 28 '25 10:11 HanslettTheDev

Yes.

Rowlando13 avatar Nov 28 '25 18:11 Rowlando13

Got it I'll request your review tomorrow

Edit I'll send it later this week instead

HanslettTheDev avatar Nov 28 '25 23:11 HanslettTheDev

Sorry, I couldn't send the update to this pull request earlier. I had an emergency. I look forward to sending an improved version of the existing PR

HanslettTheDev avatar Dec 17 '25 18:12 HanslettTheDev

No problem. There a really deadlines for Pallets projects since everyone is a volunteer.

Rowlando13 avatar Dec 17 '25 20:12 Rowlando13