Copy as Markdown[View as Markdown](/docs/cli/cli-users.md)

***

# Users CLI Commands

Manage users in your EventCatalog from the command line.

## getUser[​](#getuser "Direct link to 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/cli getUser "jsmith"
```

***

## getUsers[​](#getusers "Direct link to getUsers")

Returns all users from EventCatalog

**Arguments:** None

**Examples:**

```
# Get all users
npx @eventcatalog/cli getUsers
```

***

## writeUser[​](#writeuser "Direct link to 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[​](#rmuserbyid "Direct link to 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/cli rmUserById "jsmith"
```

***