kelvin-sdk 9.6.0
CLI tool to interact with Kelvin platform
Requires Python: <3.14,>=3.9

# Kelvin CLI

A command-line tool to interact with the Kelvin Platform.

## Installation

```bash
pip install kelvin-sdk
```

## Quick Start

### View All Available Commands

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

```bash
kelvin --tree
```


```
 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.
```

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

### Login to Kelvin Platform

Authenticate with the Kelvin platform:

```bash
kelvin auth login
```

You can specify a platform URL:

```bash
kelvin auth login alpha.kelvininc.com
```

## Getting Help

View help for any command:

```bash
kelvin --help
kelvin auth --help
kelvin auth login --help
```