pallets/click

Introduction to the command line tutorial

Open

#3076 opened on Sep 21, 2025

View on GitHub
 (13 comments) (0 reactions) (0 assignees)Python (14,710 stars) (1,419 forks)batch import
docsgood first issue

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Create a new tutorial document in myst format following Diataxis principles. Include sections on getting OS information, directory vs file, file paths, moving around, making directories, making files, editing files, printing file contents, grepping, and showing CLI help. Use docs tabs to support multiple OS/shell options. Ensure the tutorial takes approximately 15 minutes to complete and provides links to deeper resources. Review existing Click documentation for style and structure.