pallets/click

Introduction to the command line tutorial

Open

#3,076 建立於 2025年9月21日

在 GitHub 查看
 (13 留言) (0 反應) (0 負責人)Python (14,710 star) (1,419 fork)batch import
docsgood first issue

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.