Skip to main content

mr category edit-description

Update the description of an existing Category. Takes two positional arguments: the category ID and the new description. Passing an empty string clears the description. Useful for annotating categories with guidance about what Groups belong under them without renaming.

Usage

mr category edit-description <id> <new-description>

Positional arguments:

  • <id>
  • <new-description>

Examples

Set a description on category 42

mr category edit-description 42 "places and venues"

Clear the description by passing an empty string

mr category edit-description 42 ""

Flags

This command has no local flags.

Inherited global flags

FlagTypeDefaultDescription
--jsonboolfalseOutput raw JSON
--no-headerboolfalseOmit table headers
--pageint1Page number for list commands (default page size: 50)
--quietboolfalseOnly output IDs
--serverstringhttp://localhost:8181mahresources server URL (env: MAHRESOURCES_URL)

Exit Codes

0 on success; 1 on any error

See Also