apps

The apps command manages uploaded DAGs and artifacts.

`activate`

The activate subcommand activates an app version.

nx1 apps activate <version_id>

Argument

string

required

App version ID value.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`add-dag`

The add-dag subcommand adds a DAG component to an app version. You can find the DAGs locally in the /utils/app/{AppName}/{VersionName}/filename directory.

nx1 apps add-dag \
  --file <file_path> \
  --version-id <version_id>

Options

string

required

File path.

string

Filename.

string

required

App version ID.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`components`

The components subcommand manages app components within an app version..

nx1 apps components --version-id <app_version_id>

Option

string

required

App version ID.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`create`

The create subcommand creates a new app.

nx1 apps create --name <app_name>

Option

string

required

New name for the app.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`create-version`

The create-version subcommand creates a new app version.

nx1 apps create-version --app-id <ID> --name <version_name>

Options

string

required

ID of the app.

string

required

Name of the app version.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`delete`

The delete subcommand deletes an app.

nx1 apps delete <app_id>

Arguments

string

required

ID of the app.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`delete-version`

The delete-version subcommand deletes an inactive app version. You can’t delete an active app version.

nx1 apps delete-version <version_id>

Arguments

string

required

ID of the inactive app version.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`deploy`

The deploy subcommand deploys an app version.

nx1 apps deploy \
  --app-name <application_name> \
  --version <app_version_name>

Options

string

required

New name for the app.

string

Paths to additional artifacts.

string

Comma-separated list of DAG Python file paths.

string

required

App version name.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`get`

The get subcommand gets details about an app resource.

nx1 apps get <app_id>

Arguments

string

required

App ID.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`list`

The list subcommand lists app resources.

nx1 apps list

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`roles`

The roles subcommand manages app roles.

nx1 apps roles --app-id <ID>

Option

string

required

ID of the app.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`versions`

Lists app versions

nx1 apps versions --app-id <ID>

Option

string

required

ID of the app.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

Using the CLIs

CLI tools

`activate`

`add-dag`

`components`

`create`

`create-version`

`delete`

`delete-version`

`deploy`

`get`

`list`

`roles`

`versions`

Using the CLIs

CLI tools

​activate

​add-dag

​components

​create

​create-version

​delete

​delete-version

​deploy

​get

​list

​roles

​versions

`activate`

`add-dag`

`components`

`create`

`create-version`

`delete`

`delete-version`

`deploy`

`get`

`list`

`roles`

`versions`