pallets/click

Introduction to the command line tutorial

Open

#3,076 opened on 2025年9月21日

GitHub で見る
 (13 comments) (0 reactions) (0 assignees)Python (14,710 stars) (1,419 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.