Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

CLI command reference: Data Developer

One-page dataos-ctl command reference for the Data Developer persona.

The commands a Data Developer uses to get access, deploy, and operate a Data Product, pulled from the full CLI reference and organized around the Data Developer workflow. 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

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

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

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, including replicas and 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 re-run -t vulcan -n <name> -v v1alpha --sub-resource-id vulcan-plan

Refresh a deployed Data Product in place, without deleting it

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. The deletion is 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 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

Last updated

Was this helpful?