각 명령에 대한 help string 추가

[namsic]

🔍 Description

• 현재 각 명령에 help string이 없어 명령에 대한 기본 정보나 사용법을 알기 힘든 상태입니다.
• 적절한 help string을 추가하여, 별도 문서를 확인하지 않고 -h option으로 기본 정보를 알 수 있도록 합니다.

⏰ Implementation Idea

• combra.Command에 아래 필드를 추가합니다.
  • Short, Long
  • Example

예시

var connectCmd = &cobra.Command{
    Use:   "connect <addr> [username:password]",
    Short: "Connect to an ARCUS cache server interactively",
    Long: `Connect to an ARCUS cache server and execute commands interactively.

This command establishes a TCP connection to the specified server address
and allows you to send memcached protocol commands directly. If authentication
credentials are provided, SASL SCRAM-SHA-256 authentication will be performed.`,
    Example: `  # Connect without authentication
  arcusctl connect localhost:11211

  # Connect with SASL authentication
  arcusctl connect localhost:11211 myuser:mypassword

  # After connection, you can execute memcached commands:
  get mykey
  set mykey 0 0 5
  hello`,
    Args: cobra.RangeArgs(1, 2),
    // …
}

$ ./arcusctl connect -h
Connect to an ARCUS cache server and execute commands interactively.

This command establishes a TCP connection to the specified server address
and allows you to send memcached protocol commands directly. If authentication
credentials are provided, SASL SCRAM-SHA-256 authentication will be performed.

Usage:
  arcusctl connect <addr> [username:password] [flags]

Examples:
  # Connect without authentication
  arcusctl connect localhost:11211

  # Connect with SASL authentication
  arcusctl connect localhost:11211 myuser:mypassword

  # After connection, you can execute memcached commands:
  get mykey
  set mykey 0 0 5
  hello

Flags:
  -h, --help   help for connect

Global Flags:
      --config-file string
  -v, --verbose

$ ./arcusctl -h
Usage:
  arcusctl [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  connect     Connect to an ARCUS cache server interactively
  help        Help about any command

…

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

[jhpark816]

본 이슈에 대한 질문입니다.

• completion 기능은 어떤 것인가요?
• acl 기능도 help string에서 볼 수 있나요?
• connect 기능도 Docs에 기재되어야 할 것 같습니다. (간단하더라도)
  • config_file은 어떤 기능인지?

형식은 아래와 같이 표현해야 할 것 같습니다.

• username 또는 password 생략하면 어떻게 되는 지?

 arcusctl connect <addr> [<username>:<password>] [<flags>]

[namsic]

completion 기능은 어떤 것인가요?

터미널에서 입력 중 tab 키로 subcommand를 자동완성할 수 있도록 하는 스크립트를 생성합니다.
kubectl 등 cli 도구에서 일반적으로 제공하는 인터페이스이며, README에도 간단히 언급되어 있습니다.
(직접 추가한 것이 아니고, 자동 생성됩니다.)

acl 기능도 help string에서 볼 수 있나요?

현재는 모든 명령에 help string 없는 상태이고,
본 이슈를 통해 acl 포함 각 subcommand에 대한 설명을 추가 예정입니다.

(Usage와 Flags는 있고, 설명 부분과 Example은 없는 상태입니다.)

config_file은 어떤 기능인지?

acl xxx에서 zookeeper 주소 등을 입력하는 설정 파일입니다.
현재 기준 connect에서는 설정 파일의 속성을 사용하지 않지만, global flag이기 때문에 connect -h에 보여집니다.

username 또는 password 생략하면 어떻게 되는 지?

일반 telnet처럼 동작합니다.
인증을 요구하는 서버이면 명령 보냈을 때 unauthenticated 응답 수신할 것입니다.