# Command Reference {% hint style="info" %} **Passing Parameters as Environment Variables** All of the below `sl-python` CLI parameters can be passed as an environment variable by prepending `SL_` to them. For example, * the param `buildName` would be set with `SL_BUILDNAME` * the param `buildSessionId` would be set with `SL_BUILDSESSIONID` * the param `proxy` would be set with `SL_PROXY` {% endhint %} {% hint style="warning" %} **Legacy Alias Deprecation Notice** Starting with **Python Agent 2.8.0**, SeaLights supports standardised CLI parameter naming across technologies. Legacy parameter aliases remain supported for backward compatibility, but they are planned for future deprecation. Customers are strongly encouraged to migrate to the standardised CLI parameters as part of their regular maintenance and upgrade process. More information can be found in **Configuration Standards**. {% endhint %} ## Python Agent — Command Reference ### Generating a Session ID (`config`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters sl-python config \ --token \ --appName \ --branchName \ --buildName \ --scanDir \ --includeFiles \ --excludeFiles ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the Sealights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--appName--appnameName of the application.
--branchName--branchnameThe source branch of the application.
--buildName--buildnameThe build label of the current build.
--scanDir--workspacepathPath to the workspace where the source code exists.
--includeFiles--includeInclude only files whose paths match one of these patterns.
Accepts shell-style wildcards, which must be quoted.
If you want to provide multiple patterns, please use a comma between each quoted pattern. For example, "pattern1", "pattern2".
--excludeFiles--excludeOmit files whose paths match one of these patterns.
Accepts shell-style wildcards, which must be quoted.
If you want to provide multiple patterns, please use a comma between each quoted pattern. For example, "pattern1", "pattern2".
--buildSessionId--buildsessionidOptional: A user provided session ID (case-sensitive).
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console. The default value is false.
### Pull Request Session (`prConfig`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters sl-python prConfig \ --token \ --appName \ --pullRequestNumber \ --targetBranch \ --latestCommit \ --repositoryUrl \ --scanDir \ --includeFiles \ --excludeFiles ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the Sealights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--appName--appnameName of the application.
--targetBranch--targetbranchThe branch to which this PR will be merged into (already reported to SeaLights).
--latestCommit--latestcommitThe full SHA of the last commit made to the Pull Request.
--pullRequestNumber--pullrequestnumberhe number assigned to the Pull Request from the source control.
--repositoryUrl--repourlThe pull request URL for the PR to be scanned, up until the section before the pullRequestNumber value.
--scanDir--workspacepathPath to the workspace where the source code exists.
--includeFiles--includeInclude only files whose paths match one of these patterns.
Accepts shell-style wildcards, which must be quoted.
--excludeFiles--excludeOmit files whose paths match one of these patterns.
Accepts shell-style wildcards, which must be quoted.
--buildSessionId--buildsessionidOptional: A user provided session ID (case-sensitive).
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console. The default value is false.
### Scanning a Build (`scan`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash sl-python scan \ --token \ --buildSessionId ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--scmType--scm

Source control used

Current options are: git, none (Default: none).

--scmProvider--scmproviderThe provider name of your Source Control Management (SCM) tool.
Values: Github, Bitbucket and Gitlab (Default: Github).
--repositoryUrl--scmbaseurl

The URL to the repository which contains the code.

If not provided, the url of the remote GIT origin will be used.

Example: https://my.bitbucket.com/projects/ABCD/repos/XYZ/browse/A1

--scmVersion--scmversionThe version of your Source Control Management (SCM) tool. If left blank, cloud version is assumed. Otherwise, specify the version of your on-premise server.
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: false).
### Running Backend Server (`run`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash sl-python run \ --token \ --buildSessionId \ --labId \ --testStage ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--labId--labidUnique ID for a set of test labs in case multiple labs are running simultaneously (case-sensitive).
--testStage--teststageThe tests stage (e.g 'integration tests', 'regression'). The default will be 'Unit Tests'.
--testGroupId--testgroupidThe test group id.
--cov-report--cov-reportPath to generate XML coverage report.
--autoExecutionRun with auto execution (start and end execution).
--dropInitFootprintsDrop initial footprints (ignore coverage data before execution starts).
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: false).
### Test Listener - Opening a Test Stage (`start`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash sl-python start \ --token \ --buildSessionId \ --labId \ --testStage \ --testProjectId ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--labId--labidUnique ID for a set of test labs in case multiple labs are running simultaneously.
--testStage--teststageThe tests stage (e.g 'integration tests', 'regression'). The default will be 'Unit Tests'.
--testProjectId--testprojectidThe test project id.
--testGroupId--testgroupidThe test group id.
--prId--pridThe PR id.
--waitAfterStartThe time to wait after starting the execution.
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: false).
### Test Listener - Uploading Report Files (`uploadReports`) {% hint style="warning" %} Report files must be JUnit style XML reports. {% endhint %} This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash sl-python uploadReports \ --token \ --buildSessionId \ --labId \ --file \ --filesFolder ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--labId--labidUnique ID for a set of test labs in case multiple labs are running simultaneously (case-sensitive).
--file--reportfilePath to report file. This argument can be declared multiple times in order to upload multiple files.
--fileFolder--reportfilesfolder

Path to folder that contains nothing but report files. All files in folder will be uploaded.
This argument can be declared multiple times in order to upload multiple files from multiple folders containing report files.

Note: all files in the folder will be uploaded

--hasMoreRequests--hasmorerequestsSet to true if test results contains multiple reports (Default: false).
--source--sourceThe reports provider. If not set, the default will be 'Junit xml report'.
--type--type

Name of testing framework type. The report type. If not set, the default will be 'JunitReport':

  • JUnitReport - For uploading JUnit test report files.
  • commitLog - For uploading git style commit logs.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: false).
### Test Listener - Closing a Test Stage (`end`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash sl-python end \ --token \ --buildSessionId \ --labId ``` #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--labId--labidUnique ID for a set of test labs in case multiple labs are running simultaneously.
--testGroupId--testgroupidThe test group id.
--waitBeforeEndThe time to wait before ending the execution.
--help--helpShow Help message and exit.
### Running Tests via pytest, unittest, nose or behave These examples are with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. {% tabs %} {% tab title="pytest" %} ```bash sl-python pytest \ --token \ --buildSessionId \ --labId \ --testStage \ --testProjectId ``` {% endtab %} {% tab title="unittest" %} ```bash sl-python unittest \ --token \ --buildSessionId \ --labId \ --testStage \ --testProjectId ``` {% endtab %} {% tab title="nose" %} ```bash sl-python nose \ --token \ --buildSessionId \ --labId \ --testStage \ --testProjectId ``` {% endtab %} {% tab title="behave" %} ```bash sl-python behave \ --token \ --buildSessionId \ --labId \ --testStage \ --testProjectId ``` {% endtab %} {% endtabs %} #### All CLI Parameters
CLI ParameterLegacy AliasDescription
--token--tokenAccess token generated from the SeaLights server.
--tokenFile--tokenfilePath to file containing access token generated from the SeaLights server.
--buildSessionId--buildsessionidSession ID of configuration created.
--buildSessionIdFile--buildsessionidfilePath to file containing the Session ID of configuration created.
--labId--labidUnique ID for a set of test labs in case multiple labs are running simultaneously.
--testStage--teststageThe tests stage (e.g 'integration tests', 'regression'). The default will be 'Unit Tests'.
--testProjectId--testprojectidThe test project id.
--testGroupId--testgroupidThe test group id.
--prid--pridThe PR id.
--cov-report--cov-reportPath to generate XML coverage report.
--pre-test--pre-testCollect coverage per test.
--interval--intervalInterval in milliseconds to send data.
--disableTia--test-selection-disableA flag to disable the Test Optimization.
--test-selection-retry-interval--test-selection-retry-intervalTest recommendation retry interval in sec.
--test-selection-retry-timeout--test-selection-retry-timeoutTest recommendation retry timeout in sec.
--proxy--proxyAddress of proxy to run connection through.
--help--helpShow Help message and exit.
--quiet--quietSuppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: false).
## Logging Logging is configured via environment variables. By default, the agent logs at `ERROR` level only.
Environment VariableDescription
SL_DEBUGEnables agent logging when set to true. Required for any log output beyond errors.
SL_LOG_LEVELSets the log verbosity: DEBUG, INFO, WARN, ERROR (default: ERROR). Takes effect only when SL_DEBUG=true.
SL_SAVE_LOG_FILEPersists log output to sealights-python-agent.log when set to true. By default, output is written to stdout only.
{% hint style="info" %} Enable `SL_DEBUG=true` first, then use `SL_LOG_LEVEL` to control verbosity. Setting `SL_LOG_LEVEL` alone without `SL_DEBUG=true` has no effect. {% endhint %} {% tabs %} {% tab title="Bash" %} {% code overflow="wrap" %} ```bash export SL_DEBUG=true export SL_LOG_LEVEL=DEBUG # DEBUG | INFO | WARN | ERROR (default: ERROR) export SL_SAVE_LOG_FILE=true # Optional: persist logs to sealights-python-agent.log ``` {% endcode %} {% endtab %} {% tab title="GitHub Actions" %} {% code overflow="wrap" %} ```yaml - name: Run tests with SeaLights logging enabled env: SL_DEBUG: "true" SL_LOG_LEVEL: DEBUG # DEBUG | INFO | WARN | ERROR (default: ERROR) SL_SAVE_LOG_FILE: "true" # Optional: persist logs to sealights-python-agent.log run: | sl-python run ... ``` {% endcode %} {% endtab %} {% tab title="PowerShell" %} {% code overflow="wrap" %} ```powershell $env:SL_DEBUG = "true" $env:SL_LOG_LEVEL = "DEBUG" # DEBUG | INFO | WARN | ERROR (default: ERROR) $env:SL_SAVE_LOG_FILE = "true" # Optional: persist logs to sealights-python-agent.log ``` {% endcode %} {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sealights.io/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/python-agent/command-reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.