Package: nextcode-cli
NextCODE Command Line InterfaceRequirementsInstallationEnd-user installationDeveloper installationSet up a service profileCreate a service profileRunning the CLI for the first timeReleasingRequirementsPython 3.7InstallationEnd-user installationPrerequisitesNote that havingpython3(and apip3that points to that python) is a prerequisite, the easist way to fullfil this is to install both via Homebrew.To install the package you have to run the following command:$pip3installnextcode-cli-UTo verify that the installation was successful you can run the following command:$nextcodeversion
nextcode-cli/x.y.z(yyyy.mm.dd)Developer installationStart by pulling the sourcecode from git (usually from develop to be on the bleeding edge).There are two ways to set up the CLI. We recommend trying to install it into your system python indevelopmode by simply running the following command in the nextcode-cli folder (depending on your system setup you might needsudo)$pip3install-e.If you get any errors you can set up a local virtualenv in the nextcode-cli path:$source./setup.sh
$pip3install-e.Using this method means that you will always need to dosource ./setup.shto enter the virtualenv before using the tool, so we would recommend getting the first method to work unless you intend on make edits to the code yourself.Set up a service profileCreate a service profileFor any work to happen a service profile must be defined. One example is the one here below, which is Platform Dev test specific. For QA purposes this is of coursetest environment dependent!:The command is:$nextcodeprofileadd<profile-name>Follow the prompts to enter a server name and then log in through the browser window that opens up.You can also set up the profile without a prompt like this:$nextcodeprofileadd<profile-name>--domain=mydomain.wuxinextcode.com--api-key=<key>Running the CLI for the first timeOnce your installation has succeeded you can run the following command anywhere in your system:nextcodestatusOnce you finish the authentication process you should be able to view workflow jobs:nextcodeworkflowjobsTo start familiarizing yourself with the sdk you can use the --help option on all commands to see detailed information about their use.$nextcode--help
Usage:nextcode[OPTIONS]COMMAND[ARGS]...AutilityforinterfacingwithWuXiNextcodeservices.Thistoolallowsyoutocommunicatewiththepipelinesservice,CSA,workflowserviceandGORQueryAPI.Forallusageyouwillneedtoauthenticateagainstthespecificserviceprofileyouareusing.Pleaselookatthesubcommandsbelowfordetails.

Options:-v,--verbose[warning|error|info]Outputlogsfordebugging-p,--profileTEXTUseaspecificprofileforthiscommand--helpShowthismessageandexit.

Commands:csa_authenticateAuthenticateagainstCSA(forimport).importImportaTSVmanifestintoCSA.keycloakManagekeycloakusersRequiresthekeycloakadmin...loginAuthenticateagainstkeycloak.pipelinesRootsubcommandforpipelinesfunctionalityprofileConfigureserverprofiletouse.queryRootsubcommandforqueryapifunctionalitytokenPrintoutanaccesstokenforthecurrentprofileversionShowtheNextcodeCLIversion.workflowRootsubcommandforworkflowfunctionality

$nextcodeworkflow--help
Usage:nextcodeworkflow[OPTIONS]COMMAND[ARGS]...Rootsubcommandforworkflowfunctionality

Options:--helpShowthismessageandexit.

Commands:jobViewormanageindividualjobs.jobsListjobspipelinesListpipelinesprojectsListprojectsrunStartanewnextflowjob.smoketestRunasmoketestoftheworkflowservicestatusShowthestatusoftheworkflowserviceReleasingBump version and update the a date innextcodecli/VERSIONMerge to masterTag in GitlabWatch the CI fireworks.