> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/operate/v1/data-developer/cli-dev-cheetsheet.md).

# CLI command reference: Data Developer

The commands a Data Developer uses to get access, deploy, and operate a Data Product, pulled from the full [CLI reference](https://v2.dataos.info/references/interfaces/command-line-interface) and organized around the [Data Developer workflow](/operate/v1/data-developer/data-product-developer.md). For flags and examples beyond what's shown here, follow the links in each section.

## Connect and authenticate

| Command                                     | Description                                                            |
| ------------------------------------------- | ---------------------------------------------------------------------- |
| `dataos-ctl init`                           | Create a local tenant context (once per instance)                      |
| `dataos-ctl login`                          | Authenticate against the active tenant context                         |
| `dataos-ctl tenant list`                    | List configured tenant contexts, and show which is active              |
| `dataos-ctl tenant select --name <context>` | Switch the active tenant context (for example, `dev` → `stg` → `prod`) |
| `dataos-ctl health`                         | Check the CLI can reach and authenticate against the instance          |

## Confirm access and readiness

See [Get access and confirm readiness](/operate/v1/data-developer/access-and-readiness.md).

| Command                                                      | Description                                                  |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| `dataos-ctl resource get -t compute -n <name>`               | Confirm the Compute you need is attached and active          |
| `dataos-ctl resource get -t depot -n <name>`                 | Confirm a Depot (source or destination) exists and is active |
| `dataos-ctl resource get -t secret -n <name>`                | Confirm a Secret your workload references exists             |
| `dataos-ctl resource get -t lakehouse -n <name>`             | Confirm your target Lakehouse is provisioned and active      |
| `dataos-ctl depot types get`                                 | See supported Depot types and the config each requires       |
| `dataos-ctl user apikey create --id <user-id> --name <name>` | Generate an API key, for example for a git-sync Secret       |

If any of these come back missing, it's a request to your Tenant Admin (Compute, Depots, Secrets, grants) or Data Admin (Lakehouse), not something you provision yourself.

## Deploy and promote

See [Deploy and promote across environments](/operate/v1/data-developer/deploy-and-promote.md).

| Command                                                            | Description                                                        |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `dataos-ctl resource apply -f <path of manifest.yaml> --lint`      | Validate a manifest (for example `nilus.yaml`) without applying it |
| `dataos-ctl resource apply -f <path of manifest.yaml>`             | Create or update a Resource from a manifest file                   |
| `dataos-ctl resource create -f <path of manifest.yaml>`            | Create a new Resource (fails if it already exists)                 |
| `dataos-ctl resource update -f <path of manifest.yaml>`            | Update an existing Resource                                        |
| `dataos-ctl resource run -f <path of manifest.yaml> --stream-logs` | Create and run a Resource in one step, streaming logs              |
| `dataos-ctl tenant select --name <context>`                        | Point the CLI at the next environment Tenant before promoting      |

Promote the same Git ref forward through `dev` → `stg` → `prod`; never fork the project per environment.

## Operate and monitor your product

See [Operate your product](/operate/v1/data-developer/operate-your-product.md).

| Command                                                       | Description                                         |
| ------------------------------------------------------------- | --------------------------------------------------- |
| `dataos-ctl resource get -t <type> -n <name>`                 | Check a Resource's status                           |
| `dataos-ctl resource get runtime -t <type> -n <name>`         | Get detailed runtime status: replicas, conditions   |
| `dataos-ctl resource log -t <type> -n <name> --tailLines 100` | Read recent logs after a failed or suspect run      |
| `dataos-ctl resource log -t <type> -n <name> --follow`        | Stream logs continuously                            |
| `dataos-ctl resource deps -t <type> -n <name>`                | Check inbound/outbound dependencies before a change |
| `dataos-ctl resource runtime run -t <type> -n <name>`         | Trigger a run of an existing runnable Resource      |
| `dataos-ctl resource runtime re-run -t <type> -n <name>`      | Re-run a Resource after fixing a failure            |
| `dataos-ctl resource runtime pause -t <type> -n <name>`       | Pause a scheduled workflow                          |
| `dataos-ctl resource runtime resume -t <type> -n <name>`      | Resume a paused workflow                            |
| `dataos-ctl resource runtime stop -t <type> -n <name>`        | Stop a running Resource                             |
| `dataos-ctl resource delete -t <type> -n <name>`              | Retire a product no one consumes                    |

Run `resource deps` before `resource delete`, especially with `--cascade`: it's irreversible.

## Inspect Lakehouse tables

Read-only checks against tables your product reads or writes. Structuring namespaces or tables beyond your own product is a Data Admin task. See the full [Lakehouse commands](https://v2.dataos.info/references/interfaces/command-line-interface/lakehouse) reference for anything beyond inspection.

| Command                                                                                        | Description                                   |
| ---------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `dataos-ctl lakehouse namespace list --name <lakehouse>`                                       | List namespaces in a Lakehouse                |
| `dataos-ctl lakehouse table list --name <lakehouse> --namespace <ns>`                          | List tables in a namespace                    |
| `dataos-ctl lakehouse table get --name <lakehouse> --namespace <ns> --table <table> --details` | Get a table's details                         |
| `dataos-ctl lakehouse table schema get -i <lakehouse>:<ns>:<table>`                            | Get a table's schema                          |
| `dataos-ctl lakehouse table snapshot list -i <lakehouse>:<ns>:<table>`                         | List snapshots, to check what landed and when |

## Manage your own credentials

| Command                                                      | Description                           |
| ------------------------------------------------------------ | ------------------------------------- |
| `dataos-ctl user get`                                        | View your own user info and role tags |
| `dataos-ctl user apikey get`                                 | List your own API keys                |
| `dataos-ctl user apikey create --id <your-id> --name <name>` | Generate a new API key for yourself   |
| `dataos-ctl user apikey delete --name <name>`                | Revoke an API key you created         |
| `dataos-ctl user changes get`                                | View your own audit history           |

Managing other users' tags, invites, or authorization is Tenant Admin territory, not part of this persona.

## Full reference

* [CLI overview](https://v2.dataos.info/references/interfaces/command-line-interface): installation, `version`, `tenant`, `depot`
* [Resource commands](https://v2.dataos.info/references/interfaces/command-line-interface/resource): every flag for `apply`, `get`, `log`, `runtime`, `deps`
* [Lakehouse commands](https://v2.dataos.info/references/interfaces/command-line-interface/lakehouse): namespaces, tables, branches, schema, snapshots
* [User commands](https://v2.dataos.info/references/interfaces/command-line-interface/user): users, API keys, role tags


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/operate/v1/data-developer/cli-dev-cheetsheet.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.