Ikomia command line interface

CLI that provides methods to communicate with the Ikomia deployment platform. One of the main features is the ability to push your Ikomia workflow and then be able to deploy it on a suitable compute infrastructure (serverless, CPU or GPU).

Ikomia deployment platform

Installation

python -m venv .venv
source .venv/bin/activate
pip install ikomia-cli

Manage Ikomia deployment platform

Authentication

You will be invited to enter your account login and password. You will then receive your connection token with the given duration validity. Export it to your console session for the next calls of ikcli.

ikcli login --token-ttl 3600

Project main commands

List your projects

ikcli project ls

Create new project

ikcli project add <project_name> <namespace>

Push workflow

ikcli project push <project_name> <workflow_local_path>

Workflow main commands

List project workflows

ikcli project workflow ls <project_name>

Show workflow details

ikcli project workflow show <project_name> <workflow_name>

Deploy workflow

ikcli project workflow deploy <project_name> <workflow_name> <provider> <region> <{SERVERLESS, CPU or GPU} --size {XS,S,M,L or XL} 

Deployment main commands

List deployments of a given workflow

ikcli project deployment ls <project_name> <workflow_name>

Get deployment logs

ikcli project deployment logs <project_name> <workflow_name>

Get deployment usage

ikcli project deployment usage <project_name> <workflow_name>

Manage Ikomia algorithms

List local algorithms

ikcli algo local ls

Create a new empty algorithm

ikcli algo local create your_new_algo

List algorithms from Ikomia HUB

ikcli hub ls

Show Ikomia HUB algorithm details

ikcli hub show algo_name