adt CLI Reference
adt is the command-line entry point to every capability exposed by SAP ABAP
Development Tools (ADT). Commands are thin wrappers around typed contracts from
@abapify/adt-client and business services from
@abapify/adk.
Run adt --help or adt <command> --help to see the live help text; this
section documents each command group in depth.
Global options
These options are accepted by the root adt command and are inherited by every
subcommand (they can appear anywhere on the command line):
| Flag | Description |
|---|---|
--sid <sid> | SAP System ID (e.g. BHF, S0D). Overrides the default system picked by adt auth set-default. |
-v, --verbose [components] | Enable verbose logging. Optionally filter by component name (adt, http, auth, ...) or all. |
--log-level <level> | Log level: trace, debug, info, warn, error (default: info). |
--log-output <dir> | Output directory for log files (default: ./tmp/logs). |
--log-response-files | Save ADT responses as separate files alongside logs. |
--config <path> | Path to a config file (default: adt.config.ts, or .adt/config.ts if present). |
-h, --help | Show help. |
-V, --version | Print the CLI version. |
Conventions
- Auth is implicit. Every command that talks to SAP calls
getAdtClientV2()internally; it reads the cached session from~/.adt/auth.json(written byadt auth login). If no session exists or the token has expired, the command exits with an error. - Object names are upper-cased automatically — you can type
zcl_fooorZCL_FOO. --jsonswitches machine-readable output. Most commands print a human-readable table/summary by default and emit a structured JSON document with--json.- Exit codes:
0= success,1= failure,10= not-found (forstat-style commands such asadt package stat).
Command groups
Authentication
| Command | Description |
|---|---|
auth | login, logout, status, list, set-default, refresh |
ABAP development objects
| Command | Description |
|---|---|
class / interface / program / include | Classic source objects (CRUD: create / read / write / activate / delete) |
domain / dataelement / table / structure | DDIC metadata objects |
ddl / dcl | CDS DDL sources and access controls |
bdef / srvd / srvb | RAP behavior definitions, service definitions and bindings |
function | Function groups and function modules |
package | ABAP package CRUD |
badi | BAdI / Enhancement implementations (ENHO/XHH) |
Transports and versioning
| Command | Description |
|---|---|
cts | Transport requests (tr, search, tree) |
gcts | git-enabled CTS — repositories, branches, commits |
Import / export (disk ⇄ SAP)
| Command | Description |
|---|---|
checkout | Download objects to abapGit-compatible files |
checkin | Push a local abapGit/gCTS directory into SAP |
import | Import an object, package, or transport |
Source and locking
| Command | Description |
|---|---|
source | Read (get) and write (put) ABAP source |
lock / unlock / locks | Lock handling |
Testing and quality
| Command | Description |
|---|---|
aunit | Run ABAP Unit tests with coverage output (JaCoCo / Sonar) |
check | Syntax check (checkruns) |
datapreview | Open SQL preview |
abap run | Execute an ad-hoc ABAP snippet |
Navigation and inspection
| Command | Description |
|---|---|
wb | Workbench navigation — where-used, callers, callees, definition, outline |
search | Quick object search |
get | Resolve an object by name |
ls | List objects in the repository or local filesystem |
user | User lookup |
info | System and session information |
discovery | ADT discovery document |
fetch | Raw authenticated HTTP request |
Security and admin
| Command | Description |
|---|---|
strust | PSE and certificate management |
Fiori Launchpad and RFC
| Command | Description |
|---|---|
flp | Fiori Launchpad inventory (read-only) |
rfc | SOAP-over-HTTP RFC function-module calls |
Interactive
| Command | Description |
|---|---|
repl | Interactive hypermedia navigator |
Authenticating for the first time
adt auth login --sid DEV
# interactive: choose destination, enter credentials
adt auth status # confirm
Once authenticated, every other command re-uses the cached session.