CLI

Opencatapult provides command line interface as a way for user to interact with the system. In most of the time, it will make API calls and display back the result based on the API response. So it is important to make sure that the right API Url has been set in the config.

Architecture

Architecture

Commands

Following are the available commands in CLI:

Login

Login to OpenCatapult. You will be prompted to input the user's password.

Usage:

dotnet occli.dll login --user [user]

Option

Alias

Description

Allowed Values

DefaultValue

Mandatory

--user

-u

Username of the suspended user

Yes

Logout

Logout from OpenCatapult.

Usage:

dotnet occli.dll logout

Current User

Check current logged-in user.

Usage:

dotnet occli.dll currentuser

Version

Check version of the components

Usage:

dotnet occli.dll version

Account

User account related commands

Subcommands

Config

CLI Configurations

Usage:

dotnet occli.dll config [subcommands]

Subcommands

Engine

Catapult engine registration commands

Usage:

dotnet occli.dll engine [subcommands]

Subcommands

Job

Job Definition related commands

Usage:

dotnet occli.dll job [subcommands]

Subcommands

Member

Project member related commands

Usage:

dotnet occli.dll member [subcommands]

Subcommands

Model

Project Data Model related commands

Usage:

dotnet occli.dll model [subcommands]

Subcommands

Provider

Task provider registration commands

Usage:

dotnet occli.dll provider [subcommands]

Subcommands

Project

Project related commands

Usage:

dotnet occli.dll project [subcommands]

Subcommands

Property

Project Data Model Property related commands

Usage:

dotnet occli.dll property [subcommands]

Subcommands

Queue

Job Queue related commands

Usage:

dotnet occli.dll queue [subcommands]

Subcommands

Service

External service related commands

Usage:

dotnet occli.dll service [subcommands]

Subcommands

Task

Job Task Definitions related commands

Usage:

dotnet occli.dll task [subcommands]

Subcommands

Version

Get the versions of opencatapult components: CLI, API, engines, and task providers

Usage:

dotnet occli.dll version