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:
1
dotnet occli.dll login --user [user]
Copied!
Option
Alias
Description
Allowed Values
DefaultValue
Mandatory
--user
-u
Username of the suspended user
​
​
Yes
Logout
Logout from
OpenCatapult.Usage:
1
dotnet occli.dll logout
Copied!
Current User
Check current logged-in user.
Usage:
1
dotnet occli.dll currentuser
Copied!
Version
Check version of the components
Usage:
1
dotnet occli.dll version
Copied!
Account
User account related commands
Subcommands
Config
CLI Configurations
Usage:
1
dotnet occli.dll config [subcommands]
Copied!
Subcommands
Engine
Catapult engine registration commands
Usage:
1
dotnet occli.dll engine [subcommands]
Copied!
Subcommands
Job
Job Definition related commands
Usage:
1
dotnet occli.dll job [subcommands]
Copied!
Subcommands
Member
Project member related commands
Usage:
1
dotnet occli.dll member [subcommands]
Copied!
Subcommands
Model
Project Data Model related commands
Usage:
1
dotnet occli.dll model [subcommands]
Copied!
Subcommands
Provider
Task provider registration commands
Usage:
1
dotnet occli.dll provider [subcommands]
Copied!
Subcommands
Project
Project related commands
Usage:
1
dotnet occli.dll project [subcommands]
Copied!
Subcommands
Property
Project Data Model Property related commands
Usage:
1
dotnet occli.dll property [subcommands]
Copied!
Subcommands
Queue
Job Queue related commands
Usage:
1
dotnet occli.dll queue [subcommands]
Copied!
Subcommands
Service
External service related commands
Usage:
1
dotnet occli.dll service [subcommands]
Copied!
Subcommands
Task
Job Task Definitions related commands
Usage:
1
dotnet occli.dll task [subcommands]
Copied!
Subcommands
Version
Get the versions of opencatapult components: CLI, API, engines, and task providers
Usage:
1
dotnet occli.dll version
Copied!
Last modified 3yr ago