> ## Documentation Index
> Fetch the complete documentation index at: https://ekso.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Command branches

> Every top-level CLI branch at a glance. Each branch maps to a resource in the Ekso API.

## How branches work

Every CLI command lives under a top-level **branch** that names a resource — `ekso item ...`, `ekso field ...`, `ekso docs ...`. Verbs scope to that resource (`list`, `get`, `create`, `update`, `delete`) plus any resource-specific extras (`field create-list`, `docs folder create`).

You can always discover the verbs for a branch with:

```bash theme={null}
ekso <branch> --help
```

And the flags for a verb with:

```bash theme={null}
ekso <branch> <verb> --help
```

`--help` reflects the binary you have installed — treat it as the source of truth if these docs and your CLI ever drift.

## Work management

| Branch      | What it does                                                                         |
| ----------- | ------------------------------------------------------------------------------------ |
| `item`      | Items — the core unit of work. Create, list, filter, copy, screen, dependency edges. |
| `container` | Containers — top-level groupings (products, projects, support queues).               |
| `area`      | Sub-groupings within a container (front-end, database, complaints, …).               |
| `label`     | Coloured labels you attach to containers and items.                                  |
| `link`      | Item-to-item references (`Related`, `Duplicate`, …).                                 |
| `watch`     | Watchers — users who get notified on item changes.                                   |

## Process & workflow

| Branch       | What it does                                                                                |
| ------------ | ------------------------------------------------------------------------------------------- |
| `process`    | Business processes — define which fields and verbs an item uses.                            |
| `field`      | Custom and system field definitions. One verb per type — `create-date`, `create-list`, etc. |
| `constraint` | Field validation rules (regex, ranges, required-when conditions).                           |
| `rule`       | Automation rules — `when X happens, do Y`.                                                  |
| `screen`     | Item-detail screens — which fields render in which order.                                   |
| `clock`      | SLA clocks — countdown timers with start/finish/breach status.                              |

## Planning & delivery

| Branch  | What it does                                                     |
| ------- | ---------------------------------------------------------------- |
| `board` | Boards — Kanban / table / timeline views over a container.       |
| `cycle` | Cycles (sprints) — time-boxed groupings of items within a board. |

## Time & finance

| Branch          | What it does                                                 |
| --------------- | ------------------------------------------------------------ |
| `time`          | Time entries — log work against items, query by user/period. |
| `cost-center`   | Cost centers users belong to.                                |
| `job-role`      | Job roles + billing rates.                                   |
| `sku`           | Stock-unit / product codes for billable work.                |
| `crm`           | CRM records — clients items can be tagged against.           |
| `non-billable`  | Non-billable categories (Meetings, Training, Vacation).      |
| `budget-reason` | Reason codes for budget overruns / under-runs.               |
| `reporting`     | Reports — profitability, risk, time summaries.               |

## Knowledge & files

| Branch | What it does                                   |
| ------ | ---------------------------------------------- |
| `docs` | Knowledge-base folders, docs, and doc content. |
| `file` | File attachments on items and annotations.     |

## Communication

| Branch           | What it does                                                |
| ---------------- | ----------------------------------------------------------- |
| `mail-general`   | Tenant-wide mail config (block lists, suppressed subjects). |
| `mail-mailbox`   | Mailbox connections — IMAP/POP credentials.                 |
| `mail-ticketing` | Ticketing pipelines that turn inbound email into items.     |
| `notification`   | Notification preferences and history.                       |
| `hook`           | Outbound webhooks fired on rule actions.                    |

## Administration

| Branch           | What it does                                       |
| ---------------- | -------------------------------------------------- |
| `auth`           | Sign in / out, current-user details.               |
| `user`           | Tenant users. Admin-tier — requires SuperAdmin.    |
| `user-group`     | User groups for permissions. Admin-tier.           |
| `access-control` | Role grants (View / Add / Manage / …). Admin-tier. |
| `api-key`        | Mint, list, revoke API keys. Admin-tier.           |
| `meta`           | Meta data — countries, currencies, timezones.      |
| `mcp`            | MCP-server-related operations.                     |

## Migration

| Branch    | What it does                                                                                                               |
| --------- | -------------------------------------------------------------------------------------------------------------------------- |
| `migrate` | Move data from Jira, Linear, Azure DevOps, Zendesk, or Countersoft Gemini into Ekso. See [Migrate](/cli/migrate/overview). |

## Utility

| Command      | What it does                                                                                                                                                |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `completion` | Print a shell-completion script for `bash`, `zsh`, `fish`, or `pwsh`. See [Shell completion](/cli/installation#shell-completion) in the installation guide. |

## See also

* [Authentication](/cli/authentication) — how `ekso auth login` and API keys work.
* [Configuration](/cli/configuration) — the global flag and env-var surface every branch shares.
* [API Reference](/api-reference/introduction) — the underlying HTTP routes each command calls.
