Skip to main content

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

IDEMP

Create or extend .abapctl.json config (interactive in a TTY, template-write otherwise)

OptionRequiredDescription
--forcenooverwrite existing config without prompting
--templatenoskip prompts and write the placeholder template
abapctl init

abapctl system-check

READ IDEMP

Validate SAP connectivity, authentication, and write access

OptionRequiredDescription
object (positional)noobject to check
--connectionnoconnection profile name
--connection-onlynocheck TCP connectivity + authentication only
--readnocheck object resolution (requires object argument)
--writenocheck 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

WRITE

Execute ABAP statements on SAP and return text output

executes user-provided ABAP; payload may modify system state

OptionRequiredDescription
--sourceyespath to file containing ABAP statements
--connectionnoconnection profile name
abapctl run --source ./ZCL_FOO.clas.abap

abapctl tools list

READ IDEMP

List all commands with tool annotations (readOnly, destructive, idempotent)

No parameters.

abapctl tools list

abapctl tools coverage

READ IDEMP

Probe /sap/bc/adt/discovery on the active connection and report registry coverage by workspace

OptionRequiredDescription
--connectionnoconnection profile name
--categorynofilter to a single workspace and emit unimplemented hrefs
--unimplemented-onlynoemit only the unimplemented list (suppress workspace breakdown)
abapctl tools coverage

abapctl discover

READ IDEMP

Discover SAP system capabilities and available ADT services

OptionRequiredDescription
--connectionnoconnection profile name
--rawnoshow all discovered ADT services (not just mapped capabilities)
abapctl discover

abapctl recipes

READ IDEMP

List workflow recipes, structured guides for multi-step SAP tasks

OptionRequiredDescription
name (positional)norecipe name (omit to list all)
--tagsnofilter by comma-separated tags
abapctl recipes ZCL_FOO

abapctl completion

READ IDEMP

Print shell completion script (bash, zsh, fish)

prints a shell completion script; no SAP connection

OptionRequiredDescription
shell (positional)yesshell: bash, zsh, or fish
abapctl completion <shell>

abapctl config show

READ IDEMP

Display current configuration

No parameters.

abapctl config show

abapctl config set-connection

IDEMP

Switch the active SAP connection

OptionRequiredDescription
name (positional)yesname (object/name argument)
abapctl config set-connection ZCL_FOO

abapctl config add-connection

WRITE

Interactively add a new SAP connection to .abapctl.json

requires interactive terminal; non-TTY and --json exit 2

OptionRequiredDescription
name (positional)noname (object/name argument)
abapctl config add-connection ZCL_FOO