Kelvin CLI SDK Overview¶

The Kelvin SDK provides a command-line tool to interact with the Kelvin Platform.

Note

When you install the kelvin-sdk library, it will also install the kelvin-python-sdk for Python programming.

The tool is central for developers to create, test and upload Kelvin SmartApps™.

Installation¶

Install the command-line tool.

Install Python SDK
1	`pip install kelvin-sdk`

To login to a Kelvin Platform, type in the terminal;

Note

Once you are logged, you will remain logged in even through reboots of your computer.

To check which Kelvin Platform you are logged into, type kelvin info into the terminal.

Using Username and Password¶

CLI command to login to Kelvin Platform
1	`kelvin auth login`

and optionally you can add the Kelvin Platform url in the command;

CLI command to login to Kelvin Platform
kelvin auth login client.kelvin.ai

Using SSO via Browser¶

If your organization uses Single Sign-On (SSO), you can login through your browser instead of entering credentials in the terminal.

CLI command to login via SSO
kelvin auth login --browser <kelvin-platform-url>

This will open your default browser where you can authenticate using your organization's SSO provider. Once authentication is complete, the CLI will automatically receive the login session.

When you are logged in you will see the following;

CLI Login Example
$ kelvin auth login
[kelvin.sdk][2025-03-17 12:09:12][I] Refreshing metadata..
[kelvin.sdk][2026-03-10 19:18:53][I] Waiting for authentication...
Opening in existing browser session.
[kelvin.sdk][2026-03-10 19:18:57][R] Login successful.

Logout of the Kelvin Platform¶

You have two options to logout of the Kelvin Platform.

Logout¶

You can simply logout of the Kelvin Platform

CLI command to logout of Kelvin Platform
kelvin auth logout

Reset¶

If you have some strange issues, then you can completely clear all authentication and configuration cache as well.

CLI command to reset authentication cache
1	`kelvin auth reset`

Available Commands¶

Use the --tree flag to see all available commands in a tree structure:

CLI command to list Kelvin CLI commands
1	`kelvin --tree`

This displays a complete overview of all commands and subcommands available in the Kelvin CLI.

Kelvin CLI commands

Kelvin Command Overview.
    app:
        └── samples: Opens Kelvin's code samples GitHub repo.
        └── create: Create a new application based on the specified parameters.
        └── build: Build a local application into a packaged image.
        └── upload: Upload an application to the platform's Application Registry.
        └── images:
            └── list: List all locally built applications.
            └── remove: Remove an application from the local applications list.
            └── unpack: Extract the content of an application from its built image into the specified directory.
        └── test:
            └── simulator: Generates random data to application's inputs
            └── csv: Publishes data from a csv to the application.
            └── generator: Publishes data generated by a custom generator class
        └── mlflow:
            └── create: Create app based on MLFlow model.
            └── import: Import a MLFlow model into an existing Kelvin App.
            └── list: Search MLFlow models.
    apps:
        └── list: List all the available applications on the platform's Application registry.
        └── search: Search for specific apps on the platform's Application Registry.
        └── show: Show the platform details and configurations for a specific application.
        └── upload: Upload an application to the platform's Application Registry.
        └── download: Download an application from the platform and make it available locally.
        └── delete: Delete an application from the platform's Application Registry.
    appregistry:
        └── list: (Deprecated) List all the available applications on the platform's Application registry.
        └── search: (Deprecated) Search for specific apps on the platform's Application Registry.
        └── show: (Deprecated) Show the platform details and configurations for a specific application.
        └── upload: (Deprecated) Upload an application to the platform's Application Registry.
        └── download: (Deprecated) Download an application from the platform and make it available locally.
        └── delete: (Deprecated) Delete an application from the platform's Application Registry.
    auth:
        └── reset: Reset all authentication and configuration cache.
        └── login: Login on the platform.
        └── logout: Logout from the platform.
        └── token: Obtain an authentication token for the platform.
    configuration:
        └── list: List all the available configurations for this tool.
        └── set: Set a local configuration for this tool.
        └── unset: Unset a local configuration for this tool.
        └── autocomplete: Generate command-completion configuration for KSDK commands.
    reset: Reset all configurations & cache used by Kelvin SDK.
    secret:
        └── create: Create a secret on the platform.
        └── list: List all the available secrets on the platform.
        └── delete: Delete secrets on the platform.
        └── update: Update an existing secret on the platform.
    workload:
        └── list: List the workloads available on the platform.
        └── search: Search for specific workloads.
        └── show: Show the details of a specific workload.
        └── deploy: Deploy a workload with specified parameters.
        └── update: Update a specific workload based with new configurations.
        └── logs: Display the logs of a specific workload.
        └── undeploy: Undeploy and delete a workload.
        └── start: Start a workload on a node.
        └── stop: Stop a running workload.
    info: Provide system information and the currently logged platform.