GoodMemGoodMem
ReferenceCLIUser

User Onboard

User Onboard CLI command reference

goodmem user onboard

Create a usable human account and one-time enrollment

Synopsis

Create a dormant human, assign the standard USER role, and issue a one-time enrollment credential in three explicit RPCs. Completed steps are durable if a later step fails; the command prints inspect-and-resume guidance using client-generated identifiers.

goodmem user onboard [flags]

Examples

  goodmem user onboard --email [email protected] \
    --username sarah --display-name "Sarah"

Options

  -n, --display-name string         Optional human-facing name
      --email string                Unique email address
      --enrollment-id string        Optional client-provided enrollment UUID
  -f, --format string               Output format: table, json, compact, quiet (default "table")
  -h, --help                        help for onboard
      --id string                   Optional client-provided user UUID
  -l, --label strings               Label key=value (repeatable)
  -q, --quiet                       Output only the enrollment credential, or the user UUID when enrollment is skipped
      --role-assignment-id string   Optional client-provided USER role-assignment UUID
      --skip-enrollment             Do not create a one-time enrollment credential
      --skip-role                   Do not assign the instance USER role
      --username string             Optional unique username

Options inherited from parent commands

      --api-key string   API key for authentication (can also be set via GOODMEM_API_KEY environment variable)
      --server string    GoodMem server address (gRPC API)

SEE ALSO