cloudamqp / cloudamqp/cli

Team command parameter consistency: --email vs --user-id

Open
#6 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Issue

The team commands currently use inconsistent parameter names for identifying users:

  • team invite --email <string> - Uses email for inviting
  • team update --user-id <string> - Uses user-id (UUID) for updating
  • team remove --email <string> - Uses email for removing

Questions

  1. Should we standardize on one approach?

    • Option A: Always use --email for user identification
    • Option B: Always use --user-id for user identification
    • Option C: Keep current behavior (different commands use different identifiers based on what's most natural)
  2. If we standardize, which identifier is preferred?

    • Email is more user-friendly and human-readable
    • User ID (UUID) is more consistent with instance/VPC commands that use numeric IDs

Context

This was discovered during a CLI parameter consistency audit. All instance and VPC commands now consistently use --id flags instead of positional arguments.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the team invite, update, and remove command entry points and compare their current user-identification parameters with the instance and VPC commands. Resolve whether email or user ID should be standardized, then define the expected consistent CLI behavior and verify each team command follows it.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.