> For the complete documentation index, see [llms.txt](https://docs.sealights.io/knowledgebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sealights.io/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/configuration-standards/consistent-cli-parameters-naming-across-technologies.md).

# Consistent CLI Parameters Naming Across Technologies

#### Motivation

The main purpose of standardizing CLI parameter naming across all SeaLights agents is to simplify onboarding and improve usability across multi-technology environments.

By ensuring that the same concept is represented by the same parameter name across all supported technologies, we achieve:

* **Faster onboarding** – users don’t need to relearn configurations per technology
* **Consistency** – predictable and intuitive CLI usage
* **Scalability** – easier adoption in complex, multi-stack environments
* **Reduced errors** – fewer misconfigurations caused by inconsistent naming

#### Backward Compatibility

All agents must continue supporting existing CLI parameters until deprecation is technically feasible via Remote Config.

* New standardized parameters should be implemented as **aliases**
* Existing parameters must remain functional during the transition period

#### Naming Convention

All CLI parameters must follow a consistent format:

* Prefix: `--` (double dash)
* Format: **lower camel case**
  * First word starts with lowercase
  * Each subsequent word starts with uppercase

**Example**

```
--buildSessionId
--branchName
--testStage
```

***

### CLI Commands Standardisation

| Purpose                       | Standard Command                                 |
| ----------------------------- | ------------------------------------------------ |
| Create Build Session ID       | `config`                                         |
| PR Build Session              | `prConfig`                                       |
| Scan / Build Mapping          | `scan`                                           |
| End Build / Scan Notification | `completeScan`                                   |
| Instrument Code               | `instrument`                                     |
| Run Application with Agent    | `run`                                            |
| Start Test Execution          | `start` *(alias: startTestStage, openTestStage)* |
| End Test Execution            | `end` *(alias: endTestStage, closeTestStage)*    |
| Upload Test Reports           | `uploadReports`                                  |

***

### CLI Parameters Standardisation

<table><thead><tr><th width="219.62109375">Purpose</th><th width="200.515625">CLI Parameter</th><th>Notes</th></tr></thead><tbody><tr><td>Token (direct)</td><td><code>--token</code></td><td></td></tr><tr><td>Token File</td><td><code>--tokenFile</code></td><td></td></tr><tr><td>Build Session ID</td><td><code>--buildSessionId</code></td><td></td></tr><tr><td>Build Session ID File</td><td><code>--buildSessionIdFile</code></td><td></td></tr><tr><td>Application Name</td><td><code>--appName</code></td><td></td></tr><tr><td>Branch Name</td><td><code>--branchName</code></td><td></td></tr><tr><td>Build Name / ID</td><td><code>--buildName</code></td><td></td></tr><tr><td>Workspace / Source Path</td><td><code>--scanDir</code></td><td>Aliases per technology. Examples, .NET: <code>--binDir</code>, Java: <code>--workspacePath</code></td></tr><tr><td></td><td><code>--include&#x3C;item></code></td><td>.NET: <code>--includeNamespace</code>, Java: <code>--includePackages</code>, Python and Nodejs: <code>--includeFiles</code></td></tr><tr><td></td><td><code>--exclude&#x3C;item></code></td><td>.NET: <code>--excludeNamespace</code>, Java: <code>--excludePackages</code>, Python and Nodejs: <code>--excludeFiles</code></td></tr><tr><td>Lab ID</td><td><code>--labId</code></td><td></td></tr><tr><td>Test Stage</td><td><code>--testStage</code></td><td></td></tr><tr><td>Test Project ID</td><td><code>--testProjectId</code></td><td></td></tr><tr><td>Test Group ID</td><td><code>--testGroupId</code></td><td>Node, Python</td></tr><tr><td>Disable TIA</td><td><code>--disableTia</code></td><td></td></tr><tr><td>Fail Build on Error</td><td><code>--failOnError</code></td><td>Node, Go, Java</td></tr><tr><td>Log Level</td><td><code>--logLevel</code></td><td>Node, Go, Java</td></tr><tr><td>Recursive Scan</td><td><code>--recursive</code></td><td>Node, Java</td></tr><tr><td>SCM Type</td><td><code>--scmType</code></td><td></td></tr><tr><td>Repository URL</td><td><code>--repositoryUrl</code></td><td>Alias: <code>--scmUrl</code></td></tr><tr><td>SCM Provider</td><td><code>--scmProvider</code></td><td></td></tr><tr><td>SCM Version</td><td><code>--scmVersion</code></td><td></td></tr><tr><td>PR Number</td><td><code>--pullRequestNumber</code></td><td></td></tr><tr><td>Target Branch</td><td><code>--targetBranch</code></td><td></td></tr><tr><td>Latest Commit</td><td><code>--latestCommit</code></td><td></td></tr><tr><td>Report File</td><td><code>--file</code></td><td></td></tr><tr><td>Report Files Folder</td><td><code>--filesFolder</code></td><td></td></tr><tr><td>Report Type</td><td><code>--type</code></td><td></td></tr><tr><td>Report Source</td><td><code>--source</code></td><td></td></tr><tr><td>Has More Requests</td><td><code>--hasMoreRequests</code></td><td></td></tr><tr><td>Module Name</td><td><code>--moduleName</code></td><td></td></tr><tr><td>Dependencies File</td><td><code>--dependenciesFile</code></td><td>Node, Java</td></tr><tr><td>Send Contributors</td><td><code>--sendContributors</code></td><td>Node, Java</td></tr><tr><td>Collector URL</td><td><code>--collectorUrl</code></td><td>Node, Python, Go</td></tr><tr><td>Build Tags</td><td><code>--tags</code></td><td>.NET, Go</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/configuration-standards/consistent-cli-parameters-naming-across-technologies.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.