tldr: cheat sheet cho hàng nghìn lệnh, gọn hơn man page

Bạn cần giải nén một file .tar.gz, gõ man tar và nhận về hàng trăm dòng tài liệu đầy đủ nhưng không có ví dụ nào cho đúng việc mình cần. Cuối cùng vẫn phải tìm trên mạng. tldr-pages là bộ "cheat sheet" do cộng đồng viết cho hàng nghìn lệnh: mỗi trang chỉ gồm mô tả ngắn và 5–8 ví dụ cho những việc hay làm nhất. Đọc trong vài giây, chép là chạy được.

GitHub: https://github.com/tldr-pages/tldr · khoảng 64 nghìn sao · Markdown · nội dung CC BY 4.0

Cài đặt client

Repo chứa nội dung (các trang Markdown); để đọc trong terminal bạn cài một client. README liệt kê nhiều lựa chọn:

brew install tlrc              # client chính thức viết bằng Rust, lệnh là "tldr"
cargo install tlrc --locked
npm install -g tldr            # client Node.js
pipx install tldr              # client Python

Không muốn cài gì: dùng bản web tldr.inbrowser.app, có hỗ trợ offline.

Cách dùng

tldr tar           # các ví dụ hay dùng của tar
tldr git rebase    # lệnh con
tldr --update      # tải bản trang mới nhất về cache
tldr --platform linux ip    # chọn nền tảng khi lệnh khác nhau giữa các hệ điều hành
tldr --list        # liệt kê các trang có sẵn

Một trang tldr là file Markdown ngắn. Đây là phần đầu trang tar (nguồn: tldr-pages, CC BY 4.0), client hiển thị dạng tô màu:

# tar

> Archiving utility.

- [c]reate an archive and write it to a [f]ile:
`tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}`

- [c]reate a g[z]ipped archive and write it to a [f]ile:
`tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}`

Chữ trong ngoặc vuông gợi nhớ ý nghĩa từng cờ (c = create, z = gzip, f = file); phần trong {{...}} là chỗ bạn thay bằng giá trị thật.

tldr so với man và tìm trên mạng

Đóng góp

• Mỗi trang là một file Markdown theo định dạng chuẩn trong thư mục pages/ (chia theo nền tảng: common, linux, osx, windows…).
• Thiếu lệnh nào bạn hay dùng (kể cả công cụ nội bộ phổ biến), có thể gửi PR theo hướng dẫn trong CONTRIBUTING.md.
• Dự án có bản dịch cho nhiều ngôn ngữ; trang theo dõi tiến độ dịch được liên kết trong README.

Lưu ý

• Ví dụ của tldr dùng chỗ giữ chỗ như {{path/to/file}}; thay bằng đường dẫn thật trước khi chạy, nhất là với lệnh xoá hoặc ghi đè.
• Khi cờ có hành vi khác giữa GNU (Linux) và BSD (macOS), kiểm tra lại bằng man trên chính máy bạn.
• Chạy tldr --update định kỳ; client dùng cache cục bộ.

Áp dụng thế nào?

• Dev: Tập thói quen gõ tldr lệnh trước khi mở trình duyệt; với các lệnh dùng thưa như ffmpeg, rsync, openssl, nó tiết kiệm rất nhiều thời gian.
• Tech Lead: Đưa tldr vào bộ công cụ onboarding, đặc biệt cho người mới với Linux; khuyến khích team đóng góp trang cho công cụ mình dùng.
• PM: Ít thời gian tra cứu lặp lại, nhiều thời gian làm việc chính; công cụ miễn phí, chạy offline.