---
url: 'https://docs.codatum.com/features/cli/overview.md'
description: A CLI for operating Codatum from your terminal
---

# Codatum CLI (Beta)

`cdm` is a CLI for operating Codatum's features from your terminal, CI, or an AI agent. It doesn't replace everything you can do in the web UI; it mainly covers file-based editing, syncing, and validation of notebooks and the catalog, along with authentication.

The quickest way to get started is issuing a token from [Personal Access Tokens](../../account/settings/pat#issue-token) and running `cdm auth login`. For command details, see the [Codatum CLI documentation](https://cli-docs.codatum.com).

::: info
This feature is in **beta**. The specification might change without notice.
:::

## Prerequisites {#prerequisites}

* See [Requirements](../../reference/requirements#codatum-cli) for supported operating systems.
* Not available if the Codatum CLI is disallowed by a [workspace policy](../../workspace/access-and-security/policy#policy-settings).

## Key features

* Operating Codatum from your terminal, CI, or an AI agent.
* Creating, syncing, and previewing notebooks in markdown form (`.cnb.md`, a local representation of a [notebook](../notebook/overview) in Codatum).
* Managing catalog annotations with YAML (such as `.cann.yaml`).
* Authenticating with a PAT (issue one under [Personal Access Tokens](../../account/settings/pat#issue-token); for managing them within a workspace, see [Personal Access Tokens](../../workspace/access-and-security/pat#operations)).