Users CLI Commands

Manage users in your EventCatalog from the command line.

getUser

Returns a user from EventCatalog by their ID

Arguments:

Name	Type	Required	Description
id	string	Yes	The ID of the user to retrieve

Examples:

# Get a user
npx @eventcatalog/sdk getUser "jsmith"

---

getUsers

Returns all users from EventCatalog

Arguments: None

Examples:

# Get all users
npx @eventcatalog/sdk getUsers

---

writeUser

Writes a user to EventCatalog

Arguments:

Name	Type	Required	Description
user	json	Yes	User object with id, name, and markdown
options	json	No	Options: {path?, override?}

---

rmUserById

Removes a user by their ID

Arguments:

Name	Type	Required	Description
id	string	Yes	The ID of the user to remove

Examples:

# Remove a user
npx @eventcatalog/sdk rmUserById "jsmith"

---