Orbitra CLI - Orbitra

Orbitra CLI orbitra is a command-line interface for the Orbitra platform. This interface allows developers to execute different platform functionalities without writing a full Python script. The base version of the Orbitra CLI wraps commands from the Orbitra Commons SDK, such as authentication, account, email and secrets commands. If a developer needs functionalities from the Orbitra Lake or Orbitra Flows SDKs, those contexts can be plugged into the base version once the modules are installed in the environment.

Command groups

Group	Commands	Provided by
Session	login, logout	`orbitra-commons`
`account`	show, get-token	`orbitra-commons`
`email`	send	`orbitra-commons`
`secrets`	set, list, delete	`orbitra-commons`
`flows`	run, status	`orbitra-flows`
`lake`	list-namespaces, list-tables, get-table-metadata, get-data, run-query, create-or-update-table, overwrite-data, upload-bytes-to-raw, download-bytes-from-raw	`orbitra-lake`

Every command and group supports --help:

orbitra --help
orbitra flows --help
orbitra lake get-data --help

Examples

Lets say you need to run a deployment that creates tables and then check the result. You can chain a few commands:

orbitra login
orbitra flows run --deployment "my_flow/my_deployment" --parameters '{"param1": "my_value", "param2": "my_value"}' --wait
orbitra lake list-namespaces
orbitra lake list-tables --namespace "my_namespace"

Or, for an agent verifying data across multiple tables to confirm information for a user:

orbitra login --start-device-code
orbitra login --complete-device-code
orbitra lake get-data --namespace "my_namespace" --table "my_table" --limit 100
orbitra lake run-query --namespace "my_namespace" --query "SELECT COUNT(*) FROM my_other_table"

​Command groups

​Examples

Command groups

Examples