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.
Following are the available commands in CLI:
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 from OpenCatapult
.
Usage:
dotnet occli.dll logout
Check current logged-in user.
Usage:
dotnet occli.dll currentuser
Check version of the components
Usage:
dotnet occli.dll version
User account related commands
​Activate​
​List​
​Register​
​Remove​
​Suspend​
​Update​
​SetRole​
​Password Update​
​Password ResetToken​
​Password Reset​
CLI Configurations
Usage:
dotnet occli.dll config [subcommands]
Catapult engine registration commands
Usage:
dotnet occli.dll engine [subcommands]
Job Definition related commands
Usage:
dotnet occli.dll job [subcommands]
Project member related commands
Usage:
dotnet occli.dll member [subcommands]
Project Data Model related commands
Usage:
dotnet occli.dll model [subcommands]
Task provider registration commands
Usage:
dotnet occli.dll provider [subcommands]
Project related commands
Usage:
dotnet occli.dll project [subcommands]
​archive​
​clone​
​create​
​export​
​get​
​list​
​remove​
​restore​
​update​
Project Data Model Property related commands
Usage:
dotnet occli.dll property [subcommands]
Job Queue related commands
Usage:
dotnet occli.dll queue [subcommands]
External service related commands
Usage:
dotnet occli.dll service [subcommands]
Job Task Definitions related commands
Usage:
dotnet occli.dll task [subcommands]
Get the versions of opencatapult components: CLI, API, engines, and task providers
Usage:
dotnet occli.dll version