Resources
Resources

Help Text

 

The help text of the Uleska CLI is as follows:

 ___  ___  ___       _______   ________  ___  __    ________     
|\ \|\ \|\ \ |\ ___ \ |\ ____\|\ \|\ \ |\ __ \
\ \ \\\ \ \ \ \ \ __/|\ \ \___|\ \ \/ /|\ \ \|\ \
\ \ \\\ \ \ \ \ \ \_|/_\ \_____ \ \ ___ \ \ __ \
\ \ \\\ \ \ \____\ \ \_|\ \|____|\ \ \ \\ \ \ \ \ \ \
\ \_______\ \_______\ \_______\____\_\ \ \__\\ \__\ \__\ \__\
\|_______|\|_______|\|_______|\_________\|__| \|__|\|__|\|__|
\|_________|


usage: uleska-automate.py [-h] --uleska_host ULESKA_HOST --token TOKEN
[--application_id APPLICATION_ID]
[--version_id VERSION_ID]
[--application_name APPLICATION_NAME]
[--version_name VERSION_NAME] [--update_sast]
[--sast_git SAST_GIT]
[--sast_username SAST_USERNAME]
[--sast_token SAST_TOKEN] [--tools TOOLS]
[--update_container]
[--container_image CONTAINER_IMAGE]
[--container_tag CONTAINER_TAG]
[--container_connection CONTAINER_CONNECTION]
[--test] [--test_and_results] [--test_and_compare]
[--latest_results] [--compare_latest_results]
[--print_json] [--get_ids] [--app_stats]
[--fail_if_issue_risk_over FAIL_IF_ISSUE_RISK_OVER]
[--fail_if_risk_over FAIL_IF_RISK_OVER]
[--fail_if_risk_change_over FAIL_IF_RISK_CHANGE_OVER]
[--fail_if_issues_over FAIL_IF_ISSUES_OVER]
[--fail_if_issues_change_over FAIL_IF_ISSUES_CHANGE_OVER]
[--fail_if_CVSS_over FAIL_IF_CVSS_OVER] [--debug]

Uleska command line interface. To identify the project/pipeline to test you
can specify either --application_name and --version_name, or --application and
--version (passing GUIDs). (Version 0.4)

optional arguments:
-h, --help show this help message and exit
--uleska_host ULESKA_HOST
URL to the Uleska host (e.g. https://s1.uleska.com/)
(note final / is required)
--token TOKEN String for the authentication token
--application_id APPLICATION_ID
GUID for the application to reference
--version_id VERSION_ID
GUID for the application version/pipeline to reference
--application_name APPLICATION_NAME
Name for the application to reference
--version_name VERSION_NAME
Name for the version/pipeline to reference
--update_sast Add or update a SAST pipeline. Requires an pre-
existing application. See documentation for other
settings
--sast_git SAST_GIT Git URL for SAST repo. Required with --update_sast.
--sast_username SAST_USERNAME
If repo requires authentication, this is the username
to use. Optional with --update_sast.
--sast_token SAST_TOKEN
If repo requires authentication, this is the token
value to use. Optional with --update_sast.
--tools TOOLS List of tool names to use for this version. Optional
with --update_sast. Comma separated
--update_container Update a container pipeline. Requires an pre-existing
application/config. See documentation for other
settings
--container_image CONTAINER_IMAGE
Name of image to use. Required with
--update_container.
--container_tag CONTAINER_TAG
Tag to use. Required with --update_container.
--container_connection CONTAINER_CONNECTION
Connection name to use for container access. Optional
with --update_container. If not included Docker Hub is
assumed.
--test Run tests only for the application and version
referenced, do not wait for the results
--test_and_results Run tests for the application and version referenced,
and return the results from the last as JSON
--test_and_compare Run tests for the application and version referenced,
and return any differences in the results from the
last test
--latest_results Retrieve the latest test results for application and
version referenced
--compare_latest_results
Retrieve the latest test results for version and
compare
--print_json Print the relevant output as JSON to stdout
--get_ids Retrieve GUID for the application_name and
version_name supplied
--app_stats Retrieve the latest risk and vulnerabiltiy for the
whole application
--fail_if_issue_risk_over FAIL_IF_ISSUE_RISK_OVER
Causes the CLI to return a failure if any new issue
risk is over the integer specified
--fail_if_risk_over FAIL_IF_RISK_OVER
Causes the CLI to return a failure if the risk is over
the integer specified
--fail_if_risk_change_over FAIL_IF_RISK_CHANGE_OVER
Causes the CLI to return a failure if the percentage
change of increased risk is over the integer
specified. Requires 'test_and_compare' or
'compare_latest_results' functions
--fail_if_issues_over FAIL_IF_ISSUES_OVER
Causes the CLI to return a failure if the number of
issues is over the integer specified
--fail_if_issues_change_over FAIL_IF_ISSUES_CHANGE_OVER
Causes the CLI to return a failure if the percentage
change in new issues is over the integer specified.
Requires 'test_and_compare' or
'compare_latest_results' function
--fail_if_CVSS_over FAIL_IF_CVSS_OVER
Causes the CLI to return a failure if the any new
issue has a CVSS over the integer specified. Requires
'test_and_compare' or 'compare_latest_results'
function
--debug Prints debug messages