# Command-line interface

You configure the SeaLights ABAP Agent using a command-line interface program installed to `<SLABAPAgent dir>\bin` directory. You can use the command-line interface program to do the following:

* Set up the agent
* Connect the agent to SeaLights
* Define resources
* Create an Initial Build Map
* Create Build Modifications
* Create Footprints

## Run the command-line interface <a href="#toc201668086" id="toc201668086"></a>

To display the command-line interface’s help file, start Windows PowerShell as an Administrator, and change to the `<SLABAPAgent dir>\bin` directory.

{% code overflow="wrap" %}

```powershell
PS C:\Windows\system32> cd C:\apps\SLABAPAgent\bin
```

{% endcode %}

Then run the following:

{% code title="Command" overflow="wrap" %}

```powershell
.\slabapcli.exe --help
```

{% endcode %}

{% code title="Expected output" overflow="wrap" lineNumbers="true" %}

```powershell
C:\apps\SLABAPAgent\bin>slabapcli --help
usage: slabapcli [-h|--help] [-c|--config <config pathname>] [-l|--log_level <log_level>] <resource> <command> [args]
resource:
  setup:
    install   : install
    uninstall : uninstall
    migrate   : migrate config to the latest supported version
  settings:
    list : list settings
  sealights:
    list : list sealights configuration
    test : test sealights configuration
    set  : set sealights configuration
  rfc:
    list : list rfc configurations
    test : test rfc configuration
    del  : delete rfc configuration
    set  : set rfc configuration
    phd  : import performance history data
  pipeline:
    list : list pipelines
    set  : set pipeline
  proxy:
    list : list proxy configuration
    set  : set proxy configuration
  buildmap:
    run : configure one-time collection of initial build map
  buildmods:
    run : configure regular collection of build mods
    stop: stop collection of build mods
  footprints
    run : configure regular collection of footprints
    stop: stop collection of footprints
  testexecution
    list  : list open test executions
    open  : open test execution
    close : close test execution
  security
    decrypt : decrypt config file and all sqlite db files

slabapcli <resource> help for resource specific help
```

{% endcode %}

You can run `.\slabapcli.exe <resource>` help to display the help for a specific resource.

{% code title="Command" overflow="wrap" %}

```powershell
.\slabapcli.exe settings help
```

{% endcode %}

{% code title="Expected output" overflow="wrap" lineNumbers="true" %}

```powershell
PS C:\apps\SLABAPAgent\bin> .\slabapcli.exe settings help 
[2025-06-13 16:14:16.590+01:00] [info] Current ANSI Code Page: 65001 (UTF-8) (65001) 
[2025-06-13 16:14:16.590+01:00] [info] Config pathname: ../config/config.toml 
settings <command>: 
command: 
  help : settings command help 
  list : list settings 
```

{% endcode %}

## Prerequisites

Before you set up the Agent, the first step is to test your machine’s connection to SeaLights. Start Windows PowerShell as an Administrator and run the following commands:

{% code overflow="wrap" lineNumbers="true" %}

```powershell
PS Test-NetConnection {customerId}.sealights.co -Port 443 // confirm TCP reachability 
PS Invoke-WebRequest https://{customerId}.sealights.co // confirm HTTPS connectivity 
```

{% endcode %}

In each case, replace `{customerId}` with your SeaLights Customer ID.