Improve `cloudamqp` help text

未关闭
#16 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
50/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
go
领域
cli

调研方向

从根 cloudamqp 命令的帮助输出开始,将其介绍文本与所要求的 GitHub CLI 风格布局进行比较。当输出不再包含 Usage 之前的内容,并且剩余的命令、flag 和帮助部分仍能正确呈现时,即可完成。

由索引模型根据 Issue 内容生成。

描述

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`
主要语言
Go
星标
2
派生
1
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

cloudamqp/cli 的其他 Issue

查看 cloudamqp/cli 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。