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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#72,983 13 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
84/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

Mở docs/src/content/docs/setup/cli.md và xem lại danh sách tạo tác kiểm toán cùng phần work-queue. So sánh tài liệu về work-queue với các cờ của lệnh con được liệt kê trong issue; issue cũng đề xuất ghi lại các cờ đó hoặc nêu rõ rằng gh aw work-queue <subcommand> --help là nguồn thông tin chính thức. Hoàn tất khi tập hợp outcomes và hướng dẫn về các cờ work-queue đượ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 the pre-collected help output (all-help.txt and the per-command files) against docs/src/content/docs/setup/cli.md. Found 2 documentation gaps: 0 high, 1 medium, 1 low.

Findings
1. audit --artifacts docs omit the outcomes set (medium)
  • Command: gh aw audit
  • CLI help: Valid sets: activation, agent, all, detection, evals, experiment, firewall, github-api, graders, info, mcp, outcomes, usage, work-queue
  • Docs (cli.md, line ~820): Valid sets include activation, agent, all, detection, evals, experiment, firewall, github-api, graders, info, mcp, usage, and work-queue.
  • Expected: the docs list outcomes, as the logs section at line ~1271 does ("All available artifact sets: ... mcp, outcomes, usage, work-queue").
  • Fix: add outcomes to the audit artifact list in cli.md.
2. work-queue subcommand flags missing from cli.md (low)

These flags appear in gh aw work-queue ... --help but nowhere in cli.md:
--before-claim, --claim-id, --epoch, --execution-ref, --expires-at, --file, --from-config, --max-claims, --max-dispatches, --offset, --pool, --priority, --run-id, --worker-profile.

Examples from the help output:

  • --pool string Predict a fair dispatch from the captured ledger without writes or launches

  • --file string Replay a downloaded work-queue.snapshot.json (read only)

  • --from-config Resolve current scheduling and approved AW workers from the target repository's immutable default ref

  • Expected: the work-queue section documents per-subcommand flags, or links to a reference page that does.

  • Fix: add the flags to the subcommand table, or state that gh aw work-queue <subcommand> --help is authoritative.

Inspection metadata
  • Method: scanned the flag list in all-help.txt against cli.md. Also checked for typos and --no-* naming patterns. No typos or --no-* inconsistencies were found.
  • Commands inspected: all top-level commands and the work-queue subcommands in the pre-collected output.
  • Date: 2026-10-29

References: §40880383913

Generated by ✅ CLI Consistency Checker · copilot · auto · ~23 AIC · ⌖ ~1 AIC · ⊞ 4.3K · ◷

  • expires on Oct 31, 2026, 5:32 AM UTC-08:00
Ngôn ngữ chính
Go
Star
5.5k
Fork
606
Merge trung bình
4 giờ 18 phút
Pull request đã merge (30 ngày)
796

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.