tldr-pages: Trang Hướng Dẫn Dòng Lệnh Rút Gọn
/tldr
tldr-pages là một bộ sưu tập trang hướng dẫn dòng lệnh rút gọn do cộng đồng viết, tạo ra để đi cùng man page chứ không nhằm thay thế nó. Hãy dùng tldr-pages khi bạn cần một ví dụ dùng ngay cho lệnh như `tar` hay `lsof`. Bỏ qua nếu bạn cần danh sách đầy đủ mọi tham số và trường hợp đặc biệt, vì một trang tldr vốn cố tình bỏ bớt phần đó.
tldr-pages Là Gì?
tldr-pages là một bộ sưu tập mở gồm các trang hướng dẫn ngắn, dựa trên ví dụ, dành cho các công cụ dòng lệnh, do nhiều người đóng góp duy trì chứ không phải một nhà cung cấp duy nhất. Thay vì liệt kê từng tham số như man page vẫn làm, mỗi trang chỉ đưa ra vài cách dùng thực tế phổ biến của một lệnh, với phạm vi bao phủ từ hệ thống kiểu UNIX đến Windows, Android và Cisco IOS.
Ai Nên Dùng tldr-pages?
tldr-pages phù hợp với lập trình viên và quản trị hệ thống đã biết đại khái một lệnh dùng để làm gì nhưng quên mất tham số chính xác khi ngồi trước terminal. Đây cũng là lựa chọn tốt cho người mới học dòng lệnh, muốn có ví dụ dùng được ngay trước khi đọc hết một tài liệu đầy đủ, và cho các nhóm muốn có tài liệu tham khảo gọn nhẹ mà họ có thể tự mở rộng bằng pull request của mình. Nó kém phù hợp hơn nếu bạn cần tài liệu đầy đủ, chính thức về mọi tham số của một lệnh; việc đó vẫn là nhiệm vụ của man.
Những Điểm Đáng Chú Ý Của tldr-pages
- ✓Mỗi trang là một file Markdown ngắn, xoay quanh vài ví dụ cụ thể thay vì liệt kê đầy đủ tham số, bao phủ cả công cụ UNIX/Linux/macOS thường ngày lẫn lệnh trên Windows, Android, Cisco IOS và DOS.
- ✓Có client chính thức bằng Python, Rust và Node.js, cộng thêm một web client tại tldr.inbrowser.app vẫn hoạt động khi mất mạng nhờ chạy như PWA, nên việc đọc trang không phụ thuộc vào một runtime ngôn ngữ cụ thể.
- ✓Một bản PDF của toàn bộ bộ sưu tập được đính kèm mỗi bản phát hành trên GitHub, cùng các bản PDF đã dịch cho phần lớn ngôn ngữ được hỗ trợ.
- ✓Công việc dịch thuật vẫn đang tiếp diễn ở nhiều ngôn ngữ, được theo dõi trên một bảng công khai cho biết bản dịch nào đang cập nhật, bản nào đã lỗi thời.
- ✓Wiki của dự án duy trì một danh sách các client do cộng đồng xây dựng ngoài ba client chính thức.
- ✓Việc đóng góp diễn ra qua pull request Markdown thuần, nên sửa một ví dụ hay thêm một lệnh còn thiếu không đòi hỏi động vào mã nguồn của bất kỳ client nào.
- ✓Một badge trạng thái build từ GitHub Actions và một phòng chat Matrix, cùng một Matrix space rộng hơn cho các phòng liên quan, hỗ trợ việc duy trì bộ sưu tập hằng ngày.
Điểm Mạnh
- ✓Mỗi trang ưu tiên đúng lệnh mà một lập trình viên sẽ thực sự gõ, thay vì một bức tường mô tả tham số, đúng với mục tiêu cốt lõi của dự án.
- ✓Ba client chính thức (Python, Rust, Node.js) cộng thêm một PWA trên trình duyệt cho nhiều cách đọc trang tuỳ theo môi trường bạn đang dùng.
- ✓Giấy phép CC BY 4.0 giữ nội dung được tái sử dụng tự do, kể cả trong bản PDF và PDF đã dịch đi kèm mỗi bản phát hành.
- ✓Đóng góp thực sự dễ tiếp cận: trang chỉ là Markdown thuần, và dự án còn chỉ rõ những issue 'help wanted' thân thiện với người mới.
- ✓Công việc dịch thuật diễn ra tích cực với bảng tiến độ công khai, nên bộ sưu tập không chỉ có tiếng Anh trên thực tế.
Khi Nào Nên Dùng Man Page Thay Vì tldr-pages
- △Các trang được thiết kế ưu tiên ví dụ, nên một trang tldr sẽ không cho bạn thấy mọi tham số một lệnh hỗ trợ; với những trường hợp ngoài phổ biến, man vẫn là nơi cần tra.
- △Chính README ghi rõ client Node.js đã chậm cập nhật, nên client Python hoặc Rust là lựa chọn an toàn hơn lúc này.
- △README không nêu số lượng trang lệnh hiện có hay mức độ bao phủ đầy đủ cho từng nền tảng cụ thể, nên bạn sẽ không biết công cụ mình cần có được ghi tài liệu hay không cho đến khi tự kiểm tra.
- △Đóng góp đòi hỏi viết Markdown và mở pull request trên Git; README không nhắc tới cách nào nhẹ nhàng hơn để đề xuất một sửa lỗi nhỏ.
Công Cụ Hỗ Trợ Dòng Lệnh Khác
Câu Hỏi Thường Gặp
TLDR là viết tắt của 'Too Long; Didn't Read' (quá dài, không đọc), một cách nói lóng trên Internet để chỉ việc bỏ qua một đoạn văn bản dài. tldr-pages mượn cụm từ này vì các trang hướng dẫn của nó rút gọn tài liệu lệnh xuống còn vài ví dụ thực tế thay vì liệt kê từng tham số.
tldr-pages được cấp phép theo Creative Commons Attribution 4.0 (CC BY 4.0), theo badge giấy phép và file LICENSE.md của repo.
tldr-pages có thể xem trực tiếp tại tldr.inbrowser.app, một web client hoạt động cả khi mất mạng nhờ được xây như PWA, nên không cần cài phần mềm nào lên máy.
tldr-pages ghi tài liệu cho lệnh vượt xa phạm vi Linux: bao phủ cả macOS, các hệ BSD (FreeBSD, NetBSD, OpenBSD), SunOS, Android, Windows, Cisco IOS và DOS, bên cạnh các công cụ UNIX tiêu chuẩn.
tldr-pages ưu tiên một bộ ví dụ thực tế ngắn gọn thay vì phong cách liệt kê đầy đủ từng tham số của man page truyền thống. Dự án ra đời chính vì những trang như `man tar` chôn vùi cách dùng phổ biến dưới một đống mô tả tham số.
Có, tldr-pages hoan nghênh đóng góp: thêm một lệnh còn thiếu, cải thiện ví dụ cho trang có sẵn, nhận một issue đang mở gắn nhãn 'help wanted', hoặc dịch trang sang ngôn ngữ khác. Mọi thứ đều là Markdown thuần, gửi qua pull request, và tiến độ dịch được theo dõi trên một bảng công khai.
Trường Hợp Sử Dụng Tốt Nhất
- •Tra một lệnh bạn ít dùng đến mức quên mất tham số, như `tar`, `find`, hay `rsync`, mà không phải đọc hết cả trang man.
- •Hướng dẫn một kỹ sư mới vào nghề hoặc quản trị viên mới cần ví dụ dùng được ngay cho các công cụ shell thông dụng, trước khi họ quen tay.
- •Giữ một bản PDF hoặc PWA offline trên máy mà việc cài thêm client không tiện.
- •Ghi lại cách dùng cho một công cụ nội bộ hay ít phổ biến mà cả nhóm hay quên cú pháp, rồi đóng góp trang đó ngược lại cho dự án.
Repo liên quan
tldr có đáng để bạn bỏ thời gian?
ChatGPT, Claude và Perplexity đều đọc được trang này. Hỏi thử xem họ nghĩ gì về tldr.