17.1. Overview of clara

            

            
# Configure NGC credentials for use by CLI. Default 'orgteam' is 'nvidia/clara'
$ clara config --key NGC_API_KEY [--orgteam NGC_ORG/NGC_TEAM] [-y|--yes]

# Upload model
$ clara create model -p [MODEL_DIRECTORY] -t [MODEL_TYPE] [--raw]

# List models
$ clara list models

# Create a new pipeline
$ clara create pipeline -p PIPELINE_DEFINITION_FILE

# See the pipeline definition being used
$ clara describe pipeline -p PIPELINE_ID

# Create a new job
$ clara create job -n NAME -p PIPELINE_ID [-f [FILE | DIRECTORY]] [-i JOB_PRIORITY] [--start]

# Start a created job
$ clara start job -j JOB_ID [-a KEY=VALUE]...

# Get job status and associated information
$ clara describe job -j JOB_ID

# Get list of jobs
$ clara list jobs [--all] | [--canceled] | [--evicted] | [--faulted] | [--healthy] | [--pending] | [--running] | [--stopped] | [--terminated] | [--quiet]

# Get list of all pipelines
$ clara list pipeliens

# Submit request to cancel job(s)
$ clara cancel jobs [-j JOB_ID1,JOB_ID2...] [--all]

# Upload payload
$ clara upload payload -p PAYLOAD_ID -f {FILE | DIRECTORY}

# Delete payloads
$ clara delete payloads -p PAYLOAD_ID[,PAYLOAD_ID...]
        

            

            
# Create a simple plugin in any language and name the resulting executable file
# so that it begins with the prefix "clara-"
$ cat ./clara-hello
#!/bin/bash

# This plugin prints the words "hello world"
echo "hello world"

# With our plugin written, let's make it executable
$ sudo chmod +x ./clara-hello

# and move it to a location in our PATH
$ sudo mv ./clara-hello /usr/local/bin

# We have now created and "installed" a Clara plugin.
# We can begin using our plugin by invoking it from clara as if it were a regular command
$ clara hello
        

            

            
hello world
        

            

            
# We can "uninstall" a plugin by simply removing it from our PATH
$ sudo rm /usr/local/bin/clara-hello
        

            

            
# Start the Clara Deploy SDK (clara platform must be pulled for this command to work. See `clara-pull` plugin below)
$ clara platform start

# Stop the Clara Deploy SDK
$ clara platform stop [-y | --yes]

# Restart the Clara Deploy SDK
$ clara platform restart [-y | --yes]
        

            

            
# Start the DICOM Adapter with default configuration
$ clara dicom start

# Start the DICOM Adapter with custom configuration
$ clara dicom start -f CONFIG-FILE

# Restart the DICOM Adapter
$ clara dicom restart [-y | --yes]

# Stop the DICOM Adapter
$ clara dicom  [-y | --yes]

# Add (SCP) AE Title-Pipeline mapping
$ clara dicom create aetitle [-n NAME] -a AE_TITLE [-o] [-i UID1,UID2,UID3] [-p Job.Processor.Assembly.NameSpace.Class] key1=value1 key2=value2 key3=value3

# Delete (SCP) AE Title-Pipeline mapping
$ clara dicom delete aetitle -n NAME

# List all (SCP) AE Title-Pipeline mappings
$ clara dicom list aetitle

# Describe a (SCP) AE Title-Pipeline mappings
$ clara dicom describe aetitle -a AE_TITLE

# Add DICOM Source for SCP
$ clara dicom create source -a AE_TITLE -i HOSTNAME_IP

# Delete DICOM Source of SCP
$ clara dicom delete source -n NAME

# List all DICOM Sources of SCP
$ clara dicom list source

# Add DICOM Destination for Clara SCU
$ clara dicom create destination -a AE_TITLE -i HOSTNAME_IP -N NAME -p PORT

# Delete DICOM Destination of SCU
$ clara dicom delete destination -n NAME

# List all DICOM Destinations of SCU
$ clara dicom list destination

# Get DICOM Adapter health and status
$ clara dicom status
        

            

            
# Start the render service
$ clara render start

# Restart the render service
$ clara render restart [-y | --yes]

# Stop the render service
$ clara render stop [-y | --yes]
        

            

            
# Pull clara platform helm charts and configure CLI
$ clara pull platform [ -v VERSION_NUMBER ][ -y | --yes ]

# Pull clara dicom-adapter helm charts and configure CLI
$ clara pull dicomadapter [ -v VERSION_NUMBER ][ -y | --yes ]
$ clara pull dicom-adapter [ -v VERSION_NUMBER ][ -y | --yes ]
$ clara pull dicom [ -v VERSION_NUMBER ][ -y | --yes ]

# Install clara-renderer helm charts
$ clara pull clararenderer [ -v VERSION_NUMBER ][ -y | --yes ]
$ clara pull clara-renderer [ -v VERSION_NUMBER ][ -y | --yes ]
$ clara pull render [ -v VERSION_NUMBER ][ -y | --yes ]
$ clara pull renderer [ -v VERSION_NUMBER ][ -y | --yes ]

# Install clara management console helm charts
$ clara pull claraconsole [ -v VERSION_NUMBER ] [ -y | --yes ]
$ clara pull clara-console [ -v VERSION_NUMBER ] [ -y | --yes ]
$ clara pull console [ -v VERSION_NUMBER ] [ -y | --yes ]

# Pull clara pipeline
$ clara pull pipeline [-v VERSION_NUMBER] [-d DESTINATION_DIR]
        

            

            
# Start the Clara Management Console (the Clara Management Console chart must be pulled for this command to work)
$ clara console start

# Restart the Clara Management Console
$ clara console restart [-y | --yes]

# Stop the Clara Management Console
$ clara console stop [-y | --yes]