Skip to main content

erpl-adt

CLI and MCP server for the SAP ADT REST API — a single binary that talks the same HTTP endpoints Eclipse ADT uses. No Eclipse, no SAP NW RFC SDK, no JVM.

Build

Part of the Datazoo ERPL family.

What it does

  • Search and browse ABAP objects, packages, data dictionary tables, CDS views
  • Read and write source code with lock management and transport integration
  • Run tests — ABAP Unit and ATC quality checks from the command line
  • Manage transports — create, list, and release transport requests
  • MCP server — expose all capabilities to AI agents over JSON-RPC (MCP 2024-11-05)

Every command accepts --json for machine-readable output.

In action

Find ABAP objects by name pattern:

search demo

Read a data-dictionary table, with field types and check tables resolved:

ddic demo

Read ABAP source code with built-in syntax highlighting:

source demo

Browse a package recursively to enumerate everything it contains:

package demo

BW/4HANA Modeling

Search the BW catalog across ADSOs, composite providers, DTPs, transformations, and queries:

bw search demo

Inspect an ADSO's field structure, complete with the InfoObject each field maps to:

bw adso demo

Export an InfoProvider's dataflow as Mermaid — pipe it straight into a renderer or commit it next to the model:

bw mermaid demo

Quick examples

# Save connection credentials (prompts for password)
erpl-adt login --host sap.example.com --port 44300 --https --user DEVELOPER

# Search for classes matching a pattern
erpl-adt search ZCL_MY_* --type CLAS --max 20

# Read object metadata and source code
erpl-adt object read /sap/bc/adt/oo/classes/zcl_my_class
erpl-adt source read /sap/bc/adt/oo/classes/zcl_my_class/source/main

# Write source code (auto-locks, writes, unlocks)
erpl-adt source write /sap/bc/adt/oo/classes/zcl_my_class/source/main --file impl.abap

# Write and activate in one step
erpl-adt source write /sap/bc/adt/oo/classes/zcl_my_class/source/main --file impl.abap --activate

# Activate an object by name
erpl-adt activate ZCL_MY_CLASS

# Run unit tests and ATC checks (by name or URI)
erpl-adt test ZCL_MY_CLASS
erpl-adt check ZCL_MY_CLASS --variant DEFAULT

# Create a transport request and release it
erpl-adt transport create --desc "Feature XYZ" --package ZPACKAGE
erpl-adt transport release NPLK900042

# Browse packages and data dictionary
erpl-adt package tree ZPACKAGE --type CLAS
erpl-adt ddic table SFLIGHT
erpl-adt ddic cds I_AIRLINE

# Check syntax
erpl-adt source check /sap/bc/adt/oo/classes/zcl_my_class/source/main

Installation

The quickest way to run erpl-adt — no download needed:

uvx erpl-adt --help

Or install permanently:

pip install erpl-adt

Alternatively, download the binary for your platform from the latest release, or build from source.

Platform Architecture
Linux x86_64
macOS arm64, x86_64
Windows x64

Full reference

Run erpl-adt --help for the complete command listing. Key commands:

SEARCH — Search for ABAP objects
  search <pattern>                        Search for ABAP objects
      --type <type>                       Object type: CLAS, PROG, TABL, INTF, FUGR
      --max <n>                           Maximum number of results

OBJECT — Read, create, delete, lock/unlock ABAP objects
  object create                           Create an ABAP object
      --type, --name, --package           (required)
      --description, --transport
  object delete <uri>                     Delete an ABAP object
  object lock <uri>                       Lock an object for editing
  object read <name-or-uri>               Read object structure
  object run <class-name-or-uri>          Run an ABAP console class (IF_OO_ADT_CLASSRUN)
  object unlock <uri>                     Unlock an object

SOURCE — Read, write, and check ABAP source code
  source check <name-or-uri>              Check syntax
  source edit <name-or-uri>               Open source in $EDITOR and write back
  source read <name-or-uri>               Read source code
      --version <version>                 active or inactive (default: active)
      --section <section>                 main, localdefinitions, localimplementations, testclasses, all
      --color / --no-color                ANSI syntax highlighting
  source write <name-or-uri>              Write source code
      --file <path>                       Path to local source file  (required)
      --activate                          Activate the object after writing
      --optimistic                        Try lockless write first (pre-7.51 SAP)

ACTIVATE — Activate inactive ABAP objects
  activate <name-or-uri>

TEST / CHECK
  test <name-or-uri>                      Run ABAP unit tests
  check <name-or-uri>                     Run ATC quality checks
      --variant <name>                    ATC variant (default: DEFAULT)

TRANSPORT — List, create, and release transports
  transport create --desc <text> --package <pkg>
  transport list [--user <user>]
  transport release <number>

DATA DICTIONARY — Tables and CDS views
  ddic table <name>                       Get table definition (fetches lengths + descriptions by default)
      --no-resolve-types                  Skip data-element lookup; show field names and types only
      --raw                               Print raw SAP XML response
  ddic cds <name>                         Get CDS view source

PACKAGE — List contents and check package existence
  package exists <name>
  package list <name>
  package tree <name>                     Recursive BFS traversal
      --type <type>                       Filter: CLAS, PROG, TABL, INTF, FUGR
      --max-depth <n>                     (default: 50)

GLOBAL FLAGS
  --host, --port, --user, --password, --client
  --https, --insecure
  --json                                  Machine-readable JSON output
  --color / --no-color
  --timeout <sec>
  --session-file <path>                   Persist session for lock/write/unlock workflows
  -v / -vv                                INFO / DEBUG logging

EXIT CODES
  0  Success   1  Connection/auth   2  Not found   5  Activation error
  6  Lock conflict   7  Test failure   8  ATC check error   99  Internal error

MCP server

erpl-adt includes a built-in MCP server (Model Context Protocol, version 2024-11-05) that exposes all ADT operations as tools over JSON-RPC 2.0 on stdin/stdout. This lets AI agents search, read, write, test, and manage ABAP code directly.

erpl-adt mcp --host sap.example.com --port 44300 --https

Configure it in your MCP client (e.g., Claude Desktop, Claude Code):

{
  "mcpServers": {
    "erpl-adt": {
      "command": "erpl-adt",
      "args": ["mcp", "--host", "sap.example.com", "--port", "44300", "--https"],
      "env": {
        "SAP_PASSWORD": "your_password"
      }
    }
  }
}

Deploy workflow

erpl-adt also includes the original deploy workflow for automated abapGit package deployment via YAML configuration:

cat > config.yaml <<EOF
connection:
  host: localhost
  port: 50000
  use_https: false
  client: "001"
  user: DEVELOPER
  password_env: SAP_PASSWORD

repos:
  - name: flight
    url: https://github.com/SAP-samples/abap-platform-refscen-flight.git
    branch: refs/heads/main
    package: /DMO/FLIGHT
    activate: true
EOF

export SAP_PASSWORD=your_password
erpl-adt deploy -c config.yaml

The deploy workflow is an idempotent state machine: discover → create package → clone → pull → activate. Each step checks preconditions and skips if already satisfied. Re-running is safe. Supports multi-repo deployments with depends_on for topological ordering.

Building from source

git clone --recurse-submodules https://github.com/datazooDE/erpl-adt.git
cd erpl-adt
make release

Requires CMake 3.21+, Ninja, and a C++17 compiler (GCC 13+, Apple Clang 15+, or MSVC 17+). vcpkg is included as a git submodule.

To run the tests:

make test                          # Unit tests (offline, no SAP system needed)
make test-integration-py           # Integration tests (requires SAP system)

Docker

docker build -t erpl-adt .
docker run --rm -v $(pwd)/config.yaml:/config.yaml \
    -e SAP_PASSWORD=your_password \
    erpl-adt deploy -c /config.yaml

Or use Docker Compose for end-to-end provisioning with a SAP ABAP Cloud Developer Trial:

docker compose up

Telemetry

erpl-adt collects anonymous, aggregate usage telemetry (feature usage, outcomes, and durations) — never source code, object/package names, transport IDs, SAP hosts/users, or error text. It is on by default and easy to disable:

erpl-adt --no-telemetry ...          # per invocation
export DATAZOO_DISABLE_TELEMETRY=1   # or DO_NOT_TRACK=1

See TELEMETRY.md for exactly what is collected and the privacy contract.

License

Apache License 2.0 — Copyright 2026 Datazoo GmbH

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

erpl_adt-2026.7.12-py3-none-win_amd64.whl (3.6 MB view details)

Uploaded Python 3Windows x86-64

erpl_adt-2026.7.12-py3-none-manylinux_2_17_x86_64.whl (6.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

erpl_adt-2026.7.12-py3-none-macosx_11_0_arm64.whl (4.5 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

erpl_adt-2026.7.12-py3-none-macosx_10_15_x86_64.whl (4.4 MB view details)

Uploaded Python 3macOS 10.15+ x86-64

File details

Details for the file erpl_adt-2026.7.12-py3-none-win_amd64.whl.

File metadata

  • Download URL: erpl_adt-2026.7.12-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for erpl_adt-2026.7.12-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b9731c1b34d72566541fdd1a6ebb7a9017fbc9832204b442c8e95e13656268da
MD5 3108d652eb15077be5da206eb63ebca5
BLAKE2b-256 a608c8e4710994eb3026c75cd700712c1b7143297720bda5d0196c0d2d9b3d6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpl_adt-2026.7.12-py3-none-win_amd64.whl:

Publisher: release.yaml on DataZooDE/erpl-adt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erpl_adt-2026.7.12-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for erpl_adt-2026.7.12-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 1095b835b76edeeac431539d4bf8d9286594f0ee8f3ae0bf4e6d77d06976c90a
MD5 f6daa1a692d1901523741e6815f91e1a
BLAKE2b-256 516827e9e0339948b85152b63b8d10fb4f0ffd6a1d42fe77c25b26e7e4a2533c

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpl_adt-2026.7.12-py3-none-manylinux_2_17_x86_64.whl:

Publisher: release.yaml on DataZooDE/erpl-adt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erpl_adt-2026.7.12-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for erpl_adt-2026.7.12-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fc1a1a7c76b83c86945b46634b0802c71e90dc1da8ca749061853f51e7417f90
MD5 c9288f160fd92b5d09c6fce76e6abba1
BLAKE2b-256 24258b28151fec2fa3612d418f103e85f3101e6d28bec983fd225656e1193afd

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpl_adt-2026.7.12-py3-none-macosx_11_0_arm64.whl:

Publisher: release.yaml on DataZooDE/erpl-adt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erpl_adt-2026.7.12-py3-none-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for erpl_adt-2026.7.12-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 0624cd0ef80dc380c1d9b1561354237308b803cdeed126e772eea534c73b960f
MD5 040098f46e546800c90ac9c4e2883710
BLAKE2b-256 b63dda181098f7858a8f92fffb19e7a13ab35461738952c1728c189b182ebf59

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpl_adt-2026.7.12-py3-none-macosx_10_15_x86_64.whl:

Publisher: release.yaml on DataZooDE/erpl-adt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2026.9.1.2

4 files

2026.9.1.1

4 files

2026.9.1

4 files

2026.8.31

4 files

2026.8.30

4 files

2026.8.11

4 files

2026.8.10

4 files

2026.8.6

4 files

2026.7.26

4 files

2026.7.25

4 files

2026.7.17

4 files

This release

2026.7.12 This release

4 files

2026.6.27

4 files

2026.5.17

4 files

2026.5.16

4 files

2026.5.15

4 files

2026.5.2

4 files

2026.5.1

4 files

2026.4.30

4 files

2026.4.29

4 files

2026.3.7

4 files

2026.2.23

4 files

2026.2.21

4 files

2026.2.20

4 files

2026.2.16

4 files

2026.2.14.1

4 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page