Improve `cloudamqp` help text

Đang mở
#16 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
50/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
go
Lĩnh vực
cli

Hướng nghiên cứu

Bắt đầu từ nội dung trợ giúp của lệnh gốc cloudamqp và so sánh phần văn bản giới thiệu của nó với bố cục theo kiểu GitHub CLI được yêu cầu. Hoàn tất khi đầu ra không còn bao gồm phần nội dung trước Usage và các phần còn lại về lệnh, flag và trợ giúp vẫn được hiển thị chính xác.

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

Mô tả

enhancement

I think everything before Usage is a distraction:

$ cloudamqp
A command line interface for the CloudAMQP API.
Use this tool to create, manage, and delete CloudAMQP instances and VPCs.

API Key Configuration:
The CLI will look for your API key in the following order:
1. CLOUDAMQP_APIKEY environment variable
2. ~/.cloudamqprc file (JSON format)
3. If neither exists, you will be prompted to enter it

Instance API keys are automatically saved when using 'instance get' command.

Usage:
  cloudamqp [command]

Available Commands:
  audit       Get audit log in CSV format
  completion  Generate shell completion script
  help        Help about any command
  instance    Manage CloudAMQP instances
  plans       List available plans
  regions     List available regions
  team        Manage team members
  version     Show cloudamqp version information
  vpc         Manage CloudAMQP VPCs

Flags:
  -h, --help      help for cloudamqp
  -v, --version   version for cloudamqp

Use "cloudamqp [command] --help" for more information about a command.

Here's the GitHu CLI

$ gh
Work seamlessly with GitHub from the command line.

USAGE
  gh <command> <subcommand> [flags]

CORE COMMANDS
  auth:          Authenticate gh and git with GitHub
  browse:        Open repositories, issues, pull requests, and more in the browser
  codespace:     Connect to and manage codespaces
  gist:          Manage gists
  issue:         Manage issues
  org:           Manage organizations
  pr:            Manage pull requests
  project:       Work with GitHub Projects.
  release:       Manage releases
  repo:          Manage repositories

GITHUB ACTIONS COMMANDS
  cache:         Manage GitHub Actions caches
  run:           View details about workflow runs
  workflow:      View details about GitHub Actions workflows

EXTENSION COMMANDS
  actions-cache: Extension actions-cache
  milestone:     Extension milestone
  update-branch: Extension update-branch

ALIAS COMMANDS
  co:            Alias for "pr checkout"

ADDITIONAL COMMANDS
  agent-task:    Work with agent tasks (preview)
  alias:         Create command shortcuts
  api:           Make an authenticated GitHub API request
  attestation:   Work with artifact attestations
  completion:    Generate shell completion scripts
  config:        Manage configuration for gh
  extension:     Manage gh extensions
  gpg-key:       Manage GPG keys
  label:         Manage labels
  preview:       Execute previews for gh features
  ruleset:       View info about repo rulesets
  search:        Search for repositories, issues, and pull requests
  secret:        Manage GitHub secrets
  ssh-key:       Manage SSH keys
  status:        Print information about relevant issues, pull requests, and notifications across repositories
  variable:      Manage GitHub Actions variables

HELP TOPICS
  accessibility: Learn about GitHub CLI's accessibility experiences
  actions:       Learn about working with GitHub Actions
  environment:   Environment variables that can be used with gh
  exit-codes:    Exit codes used by gh
  formatting:    Formatting options for JSON data exported from gh
  mintty:        Information about using gh with MinTTY
  reference:     A comprehensive reference of all gh commands

FLAGS
  --help      Show help for command
  --version   Show gh version

EXAMPLES
  $ gh issue create
  $ gh repo clone cli/cli
  $ gh pr checkout 321

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual
  Learn about exit codes using `gh help exit-codes`
  Learn about accessibility experiences using `gh help accessibility`
Ngôn ngữ chính
Go
Star
2
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 cloudamqp/cli

Tất cả issue của cloudamqp/cli

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.