| Table of Contents |
|---|
Generating a session ID
Standard Session ID
| Code Block |
|---|
sl-python config {--token <token> | --tokenfile <file>} --appname <appname> --branchname <branch> --buildname <build> --workspacepath <path> [--include <include>] [--exclude <exclude>] [--buildsessionid <buildsessionid>] [--proxy <proxy>] [--help] |
Parameter | Description |
|---|---|
| Access token generated from the Sealights server |
| Path to file containing access token generated from the SeaLights server |
| Name of the application |
| The source branch of the application |
| The build label of the current build |
| Path to the workspace where the source code exists |
| Include only files whose paths match one of these patterns. |
| Omit files whose paths match one of these patterns. |
| Optional: A user provided session ID (case-sensitive) |
| Address of proxy to run connection through |
| Show Help message and exit. |
Pull Request Session ID
| Code Block |
|---|
sl-python prConfig {--token <token> | --tokenfile <file>} --appname <appname> --targetbranch <branch> --latestcommit <commit_sha> --pullrequestnumber <number> --repourl <url> --workspacepath <path> [--include <include>] [--exclude <exclude>] [--buildsessionid <buildsessionid>] [--proxy <proxy>] [--help] |
Parameter | Description |
|---|---|
| Access token generated from the Sealights server |
| Path to file containing access token generated from the SeaLights server |
| Name of the application |
| The branch to which this PR will be merged into (already reported to SeaLights) |
| The full SHA of the last commit made to the Pull Request |
| he number assigned to the Pull Request from the source control |
| The pull request URL for the PR to be scanned, up until the section before the pullRequestNumber value |
| Path to the workspace where the source code exists |
| Include only files whose paths match one of these patterns. |
| Omit files whose paths match one of these patterns. |
| Optional: A user provided session ID (case-sensitive) |
| Address of proxy to run connection through |
| Show Help message and exit. |
Scanning a build
| Code Block |
|---|
sl-python scan {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} --scm {git|none} [--scmBaseUrl <url> --scmProvider {github|gitlab|bitbucket} [--scmVersion <version>] [--proxy <proxy>] [--help] |
Parameter | Description |
|---|---|
| Access token generated from the SeaLights server |
| Path to file containing access token generated from the SeaLights server |
| Session ID of configuration created |
| Path to file containing the Session ID of configuration created |
| Source control used Current options are: git, none |
| The provider name of your Source Control Management (SCM) tool. |
| The URL to the repository which contains the code. If not provided, the url of the remote GIT origin will be used Example: |
| The version of your Source Control Management (SCM) tool. If left blank, cloud version is assumed. Otherwise, specify the version of your on-premise server. |
| Address of proxy to run connection through |
| Show Help message and exit. |
...