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-08

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#66,893 0 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
78/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ệ
go
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu với docs/src/content/docs/setup/cli.md và đầu ra trợ giúp của gh aw work-queue được nhắc đến trong issue; so sánh các mục lệnh tiện ích lân cận và quy ước chung về flag. Tài liệu hóa lệnh thử nghiệm, các lệnh con và flag được liệt kê, đồng thời căn chỉnh định nghĩa flag hoặc giải thích mọi khác biệt có chủ đích. Hoàn tất khi tài liệu CLI bao quát work-queue và các tùy chọn của lệnh, còn các flag tuân theo quy ước đã nêu hoặc ngoại lệ được ghi lại.

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

Inspected ~45 top-level commands (plus subcommands, 510 help files) from /tmp/gh-aw/agent/all-help.txt. Found 2 issues: 0 high, 1 medium, 1 low.

Documentation gaps

1. work-queue is not documented in docs/src/content/docs/setup/cli.md (medium)

  • Affected: gh aw work-queue and subcommands cancel-claim, cancel-work, claim, compact, finish, replay, stats, submit-work.
  • CLI output: work-queue Experimental: inspect and update a Git-backed work queue (listed under "Utilities").
  • Actual: every other top-level command has a gh aw <cmd> entry in cli.md; work-queue has none (neither its flags --branch, --claim-id, --work-id, --attempt-id, --run-id, --file).
  • Suggested fix: add a section (marked experimental) under "Utility Commands" covering the subcommands and flags.
Flag-naming inconsistencies

2. work-queue uses non-standard --repo / --json flags (low)

  • Quoted output: 
    --json            Output JSON
--repo string     GitHub repository owner/repo
  • Elsewhere (164 and 116 occurrences respectively): -j, --json Output results in JSON format and -r, --repo string Target repository ([HOST/]owner/repo format). Defaults to current repository.
  • Expected: short flags -j/-r and the standard description wording (or a documented reason for omitting GHES host support).
  • Suggested fix: align work-queue flag definitions with the shared helpers used by other commands.
Inspection metadata
  • Date: 2026-10-08; method: scripted comparison of all flags in per-command help files against cli.md, plus review of flag/description patterns (--engine, --repo, --json, --output).

Generated by ✅ CLI Consistency Checker · copilot · auto · 20 AIC · ⌖ 0.593 AIC · ⊞ 8.4K · ◷

  • expires on Oct 10, 2026, 5:34 AM UTC-08:00
Ngôn ngữ chính
Go
Star
5.4k
Fork
576
Merge trung bình
8 giờ 11 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.