Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[cli-consistency] CLI Consistency Issues - 2026-10-09

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#67,211 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Các phần còn thiếu nằm trong docs/src/content/docs/setup/cli.md. Chạy gh aw work-queue --help và gh aw compile --help để lấy các lệnh con và nội dung về --allow-experimental, rồi kiểm tra patterns/workqueue-ops.md xem đã có sẵn câu chữ nào chưa. Hoàn thành khi cli.md có mục work-queue với các lệnh con và cờ, và đoạn về --dry-run đề cập đến --allow-experimental.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

automation cli cookie documentation
Summary

Compared /tmp/gh-aw/agent/all-help.txt and per-command help against docs/src/content/docs/setup/cli.md. Found 2 documentation gaps. Severity: high 0, medium 2, low 0.

Documentation gaps
1. gh aw work-queue command family is not documented in cli.md (medium)
  • Affected: gh aw work-queue and subcommands (cancel-claim, cancel-work, compact, control, dispatch-next, evidence, explain, ...).
  • CLI output: work-queue Inspect and publish the current fair Git-backed DAG work queue
  • Actual: cli.md has no gh aw work-queue section. The only mentions are --artifacts work-queue and the --dry-run note. Flags such as --storage, --branch, --request-id, --claim-id, --work-id, --pool, --max-claims, --max-dispatches and --max-bytes are absent from the CLI reference.
  • Expected: a command section, or a link to patterns/workqueue-ops.md from cli.md.
  • Suggested fix: add a work-queue section listing subcommands and flags, based on gh aw work-queue --help.
2. gh aw compile --allow-experimental is not documented (medium)
  • CLI output: --allow-experimental Accept experimental-feature notices during dry-run compilation; notices remain visible and all other warnings and scanner failures remain fatal
  • Actual: the flag does not appear in cli.md, including the --dry-run paragraph, which says warnings are errors.
  • Expected: the flag is documented alongside --dry-run.
  • Suggested fix: add a sentence to the --dry-run paragraph, or a flag entry, describing --allow-experimental.
Inspection metadata
  • Date: 2026-10-09
  • Method: automated flag-by-flag comparison of every command's help against cli.md, plus a typo scan of all-help.txt. No typos were found.
  • Scope: all top-level commands in all-help.txt (about 45) and their help files. Run: 37936811221.

Generated by ✅ CLI Consistency Checker · copilot · auto · 18.9 AIC · ⌖ 0.597 AIC · ⊞ 8.4K · ◷

  • expires on Oct 11, 2026, 5:33 AM UTC-08:00
Ngôn ngữ chính
Go
Star
5.4k
Fork
576
Merge trung bình
8 giờ 22 phút
Pull request đã merge (30 ngày)
798

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw

Tất cả issue của github/gh-aw

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.