Teams CLI Commands

Manage teams in your EventCatalog from the command line.

getTeam

Returns a team from EventCatalog by its ID

Arguments:

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

Examples:

# Get a team
npx @eventcatalog/sdk getTeam "platform-team"

---

getTeams

Returns all teams from EventCatalog

Arguments: None

Examples:

# Get all teams
npx @eventcatalog/sdk getTeams

---

writeTeam

Writes a team to EventCatalog

Arguments:

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

---

rmTeamById

Removes a team by its ID

Arguments:

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

Examples:

# Remove a team
npx @eventcatalog/sdk rmTeamById "platform-team"

---