Standalone & config
Top-level commands plus the config group for managing local connection profiles. These set up the CLI, probe a system, and run ad-hoc ABAP.
Related guides: ai-agents.
11 commands.
abapctl init
IDEMPCreate or extend .abapctl.json config (interactive in a TTY, template-write otherwise)
| Option | Required | Description |
|---|---|---|
--force | no | overwrite existing config without prompting |
--template | no | skip prompts and write the placeholder template |
abapctl init
abapctl system-check
READ IDEMPValidate SAP connectivity, authentication, and write access
| Option | Required | Description |
|---|---|---|
object (positional) | no | object to check |
--connection | no | connection profile name |
--connection-only | no | check TCP connectivity + authentication only |
--read | no | check object resolution (requires object argument) |
--write | no | check lock/unlock access (requires object argument) |
--read and --write are checks against a specific object, so each needs the object argument. Without an object, system-check verifies connectivity and authentication only.
abapctl system-check # connectivity + auth
abapctl system-check ZCL_FOO --read # also resolve the object
abapctl system-check ZCL_FOO --write # also test lock/unlock access
abapctl run
WRITEExecute ABAP statements on SAP and return text output
executes user-provided ABAP; payload may modify system state
| Option | Required | Description |
|---|---|---|
--source | yes | path to file containing ABAP statements |
--connection | no | connection profile name |
abapctl run --source ./ZCL_FOO.clas.abap
abapctl tools list
READ IDEMPList all commands with tool annotations (readOnly, destructive, idempotent)
No parameters.
abapctl tools list
abapctl tools coverage
READ IDEMPProbe /sap/bc/adt/discovery on the active connection and report registry coverage by workspace
| Option | Required | Description |
|---|---|---|
--connection | no | connection profile name |
--category | no | filter to a single workspace and emit unimplemented hrefs |
--unimplemented-only | no | emit only the unimplemented list (suppress workspace breakdown) |
abapctl tools coverage
abapctl discover
READ IDEMPDiscover SAP system capabilities and available ADT services
| Option | Required | Description |
|---|---|---|
--connection | no | connection profile name |
--raw | no | show all discovered ADT services (not just mapped capabilities) |
abapctl discover
abapctl recipes
READ IDEMPList workflow recipes, structured guides for multi-step SAP tasks
| Option | Required | Description |
|---|---|---|
name (positional) | no | recipe name (omit to list all) |
--tags | no | filter by comma-separated tags |
abapctl recipes ZCL_FOO
abapctl completion
READ IDEMPPrint shell completion script (bash, zsh, fish)
prints a shell completion script; no SAP connection
| Option | Required | Description |
|---|---|---|
shell (positional) | yes | shell: bash, zsh, or fish |
abapctl completion <shell>
abapctl config show
READ IDEMPDisplay current configuration
No parameters.
abapctl config show
abapctl config set-connection
IDEMPSwitch the active SAP connection
| Option | Required | Description |
|---|---|---|
name (positional) | yes | name (object/name argument) |
abapctl config set-connection ZCL_FOO
abapctl config add-connection
WRITEInteractively add a new SAP connection to .abapctl.json
requires interactive terminal; non-TTY and --json exit 2
| Option | Required | Description |
|---|---|---|
name (positional) | no | name (object/name argument) |
abapctl config add-connection ZCL_FOO