Command reference

Overview of all Nuvolos CLI commands

Auto-generated Reference

nuvolos

Usage:

nuvolos [OPTIONS] COMMAND [ARGS]...

Options:

  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  --help               Show this message and exit.

apps

Usage:

nuvolos apps [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

create

Creates a new application in the development snapshot of the specified instance.

Usage:

nuvolos apps create [OPTIONS]

Options:

  -o, --org TEXT          The slug of the Nuvolos organization
  -s, --space TEXT        The slug of the Nuvolos space
  -i, --instance TEXT     The slug of the Nuvolos instance
  --imid INTEGER          The image ID to use for the application  [required]
  -n, --name TEXT         The long_id (display name) of the application
                          [required]
  -d, --description TEXT  The description of the application
  --pars TEXT             JSON string of application parameters
  -f, --format TEXT       Sets the output into the desired format. Available
                          values: `tabulated`, `json`, `yaml`
  --help                  Show this message and exit.

derive

Creates a derived image from an existing Nuvolos application.

Usage:

nuvolos apps derive [OPTIONS]

Options:

  -o, --org TEXT            The slug of the Nuvolos organization
  -s, --space TEXT          The slug of the Nuvolos space
  -i, --instance TEXT       The slug of the Nuvolos instance
  -a, --app TEXT            The slug of the application to derive from
                            [required]
  -t, --tag TEXT            The image tag for the derived image
  -e, --email / --no-email  Send email once the derivation is finished
                            (default: yes)
  -w, --wait                Wait until the derivation task is complete
  -f, --format TEXT         Sets the output into the desired format. Available
                            values: `tabulated`, `json`, `yaml`
  --help                    Show this message and exit.

execute

Executes COMMAND in a Nuvolos application.

Example: nuvolos apps execute -a my_slug "python -c 'from time import sleep;sleep(10)'"

Usage:

nuvolos apps execute [OPTIONS] COMMAND

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to execute
                       a command in an application
  -s, --space TEXT     The slug of the Nuvolos space to use to execute a
                       command in an application
  -i, --instance TEXT  The slug of the Nuvolos instance to use to execute a
                       command in an application
  -a, --app TEXT       The slug of the Nuvolos application where the command
                       is executed  [required]
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

list

Lists the Nuvolos applications available to the current user.

Usage:

nuvolos apps list [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to list
                       applications
  -s, --space TEXT     The slug of the Nuvolos space to use to list
                       applications
  -i, --instance TEXT  The slug of the Nuvolos instance to use to list
                       applications
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use to list
                       applications
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

nodepools

Lists all nodepools available for dedicated app launch.

Usage:

nuvolos apps nodepools [OPTIONS]

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

running

Lists all running Nuvolos applications of the user. If the app is specified, lists all running workloads for the given application.

Usage:

nuvolos apps running [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to list
                       running workloads for an application
  -s, --space TEXT     The slug of the Nuvolos space to use to list running
                       workloads for an application
  -i, --instance TEXT  The slug of the Nuvolos instance to use to list running
                       workloads for an application
  -a, --app TEXT       The slug of the Nuvolos application to use to list
                       running an workloads
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

start

Starts the Nuvolos application with the APP application slug.

Usage:

nuvolos apps start [OPTIONS] APP

Options:

  -o, --org TEXT        The slug of the Nuvolos organization to use to start
                        an application
  -s, --space TEXT      The slug of the Nuvolos space to use to start an
                        application
  -i, --instance TEXT   The slug of the Nuvolos instance to use to start an
                        application
  -n, --node-pool TEXT  The node pool to use to run the app
  -w, --wait            Waits until the started application is in a running
                        state
  --help                Show this message and exit.

stop

Stops the Nuvolos application with the given application slug.

Usage:

nuvolos apps stop [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to stop an
                       application
  -s, --space TEXT     The slug of the Nuvolos space to use to stop an
                       application
  -i, --instance TEXT  The slug of the Nuvolos instance to use to stop an
                       application
  -a, --app TEXT       The slug of the Nuvolos application to stop  [required]
  --help               Show this message and exit.

config

Initializes a new Nuvolos CLI configuration in the current directory.

Usage:

nuvolos config [OPTIONS]

Options:

  --api-key TEXT  The Nuvolos API key to use for authentication  [required]
  --help          Show this message and exit.

distribution

Distributes content from a snapshot to target instances.

Usage:

nuvolos distribution [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

distribute

Distribute selected files, applications, and tables from a snapshot to target instances.

Usage:

nuvolos distribution distribute [OPTIONS]

Options:

  -o, --org TEXT                  The slug of the source Nuvolos organization
  -s, --space TEXT                The slug of the source Nuvolos space
  -i, --instance TEXT             The slug of the source Nuvolos instance
  -p, --snapshot TEXT             The slug of the source snapshot to
                                  distribute from (default: development)
  --targets TEXT                  JSON array of target instances, each with
                                  org_slug, space_slug, instance_slug
                                  [required]
  --apps TEXT                     Comma-separated list of application slugs to
                                  distribute
  --files TEXT                    Comma-separated list of file paths to
                                  distribute
  --tables TEXT                   Comma-separated list of table names to
                                  distribute
  --auto-snapshot / --no-auto-snapshot
                                  Create a snapshot of target instances before
                                  distributing (default: no)
  --notify / --no-notify          Notify target users when distribution is
                                  complete (default: no)
  --message TEXT                  Custom email message to send with the
                                  notification
  -w, --wait                      Wait until the distribution task is complete
  -f, --format TEXT               Sets the output into the desired format.
                                  Available values: `tabulated`, `json`,
                                  `yaml`
  --help                          Show this message and exit.

files

Manages files in snapshot areas.

Usage:

nuvolos files [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

Lists files in the selected snapshot area.

Usage:

nuvolos files list [OPTIONS]

Options:

  -o, --org TEXT           The slug of the Nuvolos organization
  -s, --space TEXT         The slug of the Nuvolos space
  -i, --instance TEXT      The slug of the Nuvolos instance
  -p, --snapshot TEXT      The slug of the Nuvolos snapshot to use
  -a, --area [files|home]  Area to list files from (default: files)
  --path TEXT              Optional path inside the selected area
  -f, --format TEXT        Sets the output into the desired format. Available
                           values: `tabulated`, `json`, `yaml`
  --help                   Show this message and exit.

image-families

Manages Nuvolos image families.

Usage:

nuvolos image-families [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

create

Creates a new image family. Priority is automatically set.

Usage:

nuvolos image-families create [OPTIONS]

Options:

  -n, --name TEXT         Name of the image family  [required]
  --icon-url TEXT         URL of the icon for the image family  [required]
  -d, --description TEXT  Description of the image family
  --groups TEXT           Comma-separated list of groups
  -f, --format TEXT       Sets the output into the desired format. Available
                          values: `tabulated`, `json`, `yaml`
  --help                  Show this message and exit.

list

Lists all image families.

Usage:

nuvolos image-families list [OPTIONS]

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

Manages Nuvolos image links.

Usage:

nuvolos image-links [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

Lists all image links accessible to the current user.

Usage:

nuvolos image-links list [OPTIONS]

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

images

Manages Nuvolos images.

Usage:

nuvolos images [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

create

Creates a new image record.

Usage:

nuvolos images create [OPTIONS]

Options:

  -n, --name TEXT             Name of the image  [required]
  --docker-image-url TEXT     Docker image URL (e.g. registry/repo:tag)
                              [required]
  --description-md TEXT       Markdown description of the image  [required]
  --ifid INTEGER              Image family ID to associate with  [required]
  -d, --description TEXT      Short description of the image
  --public / --no-public      Whether the image is public
  --public-description TEXT   Public-facing description
  -o, --org TEXT              Org slug to scope the image to (omit for global)
  -s, --space TEXT            Space slug to scope the image to
  --app-type TEXT             Application type identifier
  --configuration TEXT        JSON string of configuration parameters
  --has-tables / --no-tables  Whether the image supports database tables
  --complexity INTEGER        Complexity level of the image
  --tags TEXT                 JSON string of tags
  -f, --format TEXT           Sets the output into the desired format.
                              Available values: `tabulated`, `json`, `yaml`
  --help                      Show this message and exit.

list

Lists all images accessible to the current user.

Usage:

nuvolos images list [OPTIONS]

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

update

Updates an existing image record. Only provided fields are updated.

Usage:

nuvolos images update [OPTIONS] IMID

Options:

  -n, --name TEXT            New name for the image
  --docker-image-url TEXT    New docker image URL
  -d, --description TEXT     New short description
  --description-md TEXT      New markdown description
  --public / --no-public     Whether the image is public
  --public-description TEXT  New public-facing description
  --app-type TEXT            New application type identifier
  --configuration TEXT       JSON string of new configuration parameters
  --complexity INTEGER       New complexity level
  --tags TEXT                JSON string of new tags
  -f, --format TEXT          Sets the output into the desired format.
                             Available values: `tabulated`, `json`, `yaml`
  --help                     Show this message and exit.

info

Prints information about the Nuvolos CLI.

Usage:

nuvolos info [OPTIONS]

Options:

  --help  Show this message and exit.

instances

Usage:

nuvolos instances [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

create

Creates a new instance in the specified space.

Usage:

nuvolos instances create [OPTIONS]

Options:

  -o, --org TEXT          The slug of the Nuvolos organization
  -s, --space TEXT        The slug of the Nuvolos space
  -n, --name TEXT         The name of the instance to create  [required]
  --slug TEXT             The slug for the new instance (auto-generated from
                          name if not provided)
  -d, --description TEXT  The description of the instance to create
  -f, --format TEXT       Sets the output into the desired format. Available
                          values: `tabulated`, `json`, `yaml`
  --help                  Show this message and exit.

list

Lists the Nuvolos instances available to the current user.

Usage:

nuvolos instances list [OPTIONS]

Options:

  -o, --org TEXT     The slug of the Nuvolos organization to use to list
                     instances
  -s, --space TEXT   The slug of the Nuvolos space to use to list instances
  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

orgs

Usage:

nuvolos orgs [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

Lists the Nuvolos organizations available to the current user.

Usage:

nuvolos orgs list [OPTIONS]

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

sessions

Manages Nuvolos application sessions.

Usage:

nuvolos sessions [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

Lists sessions for a given application.

Usage:

nuvolos sessions list [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -a, --app TEXT       The slug of the Nuvolos application  [required]
  --page INTEGER       Page number (default: 1)
  --per-page INTEGER   Results per page (default: 100)
  --session-id TEXT    Filter by a specific session ID
  --sort [asc|desc]    Sort order (default: desc)
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

logs

Retrieves logs for a specific session and container.

Usage:

nuvolos sessions logs [OPTIONS]

Options:

  --session-id TEXT              The session ID to get logs for  [required]
  -c, --container TEXT           The container name to get logs from
                                 [required]
  --max-lines INTEGER            Maximum number of log lines to return
                                 (default: 100)
  --from-start TEXT              ISO datetime to start reading logs from
  -f, --format [tabulated|json]  Sets the output into the desired format.
                                 Available values: `tabulated`, `json`
  --columns TEXT                 Comma-separated list of columns to include
                                 (e.g. 'msg,ts')
  --help                         Show this message and exit.

snapshots

Usage:

nuvolos snapshots [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

create

Creates a new snapshot in the given instance.

Usage:

nuvolos snapshots create [OPTIONS]

Options:

  -o, --org TEXT          The slug of the Nuvolos organization to use to
                          create a snapshot
  -s, --space TEXT        The slug of the Nuvolos space to use to create a
                          snapshot
  -i, --instance TEXT     The slug of the Nuvolos instance to use to create a
                          snapshot
  -n, --name TEXT         The name of the snapshot to create  [required]
  -d, --description TEXT  The description of the snapshot to create
  -e, --email             Send an email notification when snapshot creation is
                          complete
  -w, --wait              Wait until snapshot creation is complete
  -f, --format TEXT       Sets the output into the desired format. Available
                          values: `tabulated`, `json`, `yaml`
  --help                  Show this message and exit.

delete

Deletes a snapshot from the given instance.

Usage:

nuvolos snapshots delete [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to delete a
                       snapshot
  -s, --space TEXT     The slug of the Nuvolos space to use to delete a
                       snapshot
  -i, --instance TEXT  The slug of the Nuvolos instance to use to delete a
                       snapshot
  -p, --snapshot TEXT  The slug of the snapshot to delete  [required]
  -w, --wait           Wait until snapshot deletion is complete
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

list

Lists the Nuvolos snapshots available to the current user.

Usage:

nuvolos snapshots list [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization to use to list
                       snapshots
  -s, --space TEXT     The slug of the Nuvolos space to use to list snapshots
  -i, --instance TEXT  The slug of the Nuvolos instance to use to list
                       snapshots
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

spaces

Usage:

nuvolos spaces [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

Lists the Nuvolos organizations / spaces / instances / apps available to the current user.

Usage:

nuvolos spaces list [OPTIONS]

Options:

  -o, --org TEXT     The slug of the Nuvolos organization to use to list
                     spaces
  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

tables

Manages tables in snapshots.

Usage:

nuvolos tables [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

columns

Returns columns for TABLE in the selected snapshot.

Usage:

nuvolos tables columns [OPTIONS] TABLE

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

ddl

Returns DDL for TABLE in the selected snapshot.

Usage:

nuvolos tables ddl [OPTIONS] TABLE

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

delete

Deletes TABLE from the selected snapshot.

Usage:

nuvolos tables delete [OPTIONS] TABLE

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  --help               Show this message and exit.

list

Lists tables in the selected snapshot.

Usage:

nuvolos tables list [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

rename

Renames TABLE in the selected snapshot.

Usage:

nuvolos tables rename [OPTIONS] TABLE

Options:

  --new-slug TEXT      New slug for the table
  --new-name TEXT      New display name for the table
  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

schema-ddl

Returns the database schema DDL for the selected snapshot.

Usage:

nuvolos tables schema-ddl [OPTIONS]

Options:

  -o, --org TEXT       The slug of the Nuvolos organization
  -s, --space TEXT     The slug of the Nuvolos space
  -i, --instance TEXT  The slug of the Nuvolos instance
  -p, --snapshot TEXT  The slug of the Nuvolos snapshot to use
  -f, --format TEXT    Sets the output into the desired format. Available
                       values: `tabulated`, `json`, `yaml`
  --help               Show this message and exit.

tasks

Manages Nuvolos tasks.

Usage:

nuvolos tasks [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

get

Retrieves the status and details of a specific task by its ID.

Usage:

nuvolos tasks get [OPTIONS] TKID

Options:

  -f, --format TEXT  Sets the output into the desired format. Available
                     values: `tabulated`, `json`, `yaml`
  --help             Show this message and exit.

Command Groups

The Nuvolos CLI is organized into the following command groups:

Organization and Space Management

  • nuvolos orgs list - List organizations
  • nuvolos spaces list - List spaces in an organization

Instance Management

  • nuvolos instances list - List instances in a space
  • nuvolos instances create - Create a new instance

See Instance Management for detailed usage.

Snapshot Management

  • nuvolos snapshots list - List snapshots in an instance
  • nuvolos snapshots create - Create a new snapshot
  • nuvolos snapshots delete - Delete a snapshot

See Snapshot Management for detailed usage.

Application Management

  • nuvolos apps list - List applications in a snapshot
  • nuvolos apps create - Create a new application
  • nuvolos apps derive - Derive an image from an application
  • nuvolos apps start - Start an application
  • nuvolos apps stop - Stop an application
  • nuvolos apps running - List running applications or workloads
  • nuvolos apps execute - Execute a command in an application
  • nuvolos apps nodepools - List available node pools

See Application Management for detailed usage.

Image Management

  • nuvolos images list - List available images
  • nuvolos images create - Create a new image
  • nuvolos images update - Update an existing image

See Image Management for detailed usage.

Image Families

  • nuvolos image-families list - List image families
  • nuvolos image-families create - Create a new image family

Permission Required

Creating image families requires the Image Manager role. To obtain this role, contact support@nuvolos.cloud.

See Image Families Management for detailed usage.

  • nuvolos image-links list - List image links

See Image Links Management for detailed usage.

Session Management

  • nuvolos sessions list - List sessions for an application
  • nuvolos sessions logs - Retrieve logs from a session (default markdown table output; supports -f json and --columns)

See Session Management for detailed usage.

Files Management

  • nuvolos files list - List files from files or home snapshot areas

See Files Management for detailed usage.

Tables Management

  • nuvolos tables list - List tables in a snapshot
  • nuvolos tables schema-ddl - Get schema DDL for a snapshot
  • nuvolos tables columns - Get columns for a table
  • nuvolos tables ddl - Get DDL for a table
  • nuvolos tables rename - Rename a table
  • nuvolos tables delete - Delete a table

See Tables Management for detailed usage.

Distribution

  • nuvolos distribution distribute - Distribute files, applications, and tables from a snapshot to target instances

See Distribution Management for detailed usage.

Task Management

  • nuvolos tasks get - Get status of a task by ID

Configuration and Info

  • nuvolos config - Initialize CLI configuration
  • nuvolos info - Display CLI information