pull Command Requirements

Overview

Pull and activate ABAP objects from git repository.

Command

# Auto-detect git remote and branch from current directory
abapgit-agent pull

# Pull specific files only (fast)
abapgit-agent pull --files src/zcl_my_class.clas.abap,src/zcl_other.clas.abap

# Pull from specific branch
abapgit-agent pull --branch develop

# Pull from specific URL
abapgit-agent pull --url https://github.com/org/repo.git

# With transport request
abapgit-agent pull --transport DEVK900001

# Combined options
abapgit-agent pull --branch develop --files src/zcl_my_class.clas.abap --transport DEVK900001

# Using transport from config/environment (no --transport flag needed)
abapgit-agent pull

# Sync serializer XML to git after pull (see XML Sync below)
abapgit-agent pull --files src/zcl_my_class.clas.abap --sync-xml

Prerequisite

Current folder is git repo root (unless --url specified)
Git remote is configured (unless --url specified)
.abapGitAgent exists with valid credentials

Project-Level Safeguards

Project maintainers can configure safeguards and conflict detection defaults in .abapgit-agent.json (checked into repository):

{
  "safeguards": {
    "requireFilesForPull": true,
    "disablePull": false,
    "reason": "Large project with 500+ objects"
  },

  "conflictDetection": {
    "mode": "ignore",
    "reason": "Single-developer project"
  }
}

When requireFilesForPull: true:

abapgit-agent pull → ❌ Error: –files is required
abapgit-agent pull --files ... → ✅ Works

When disablePull: true:

All pull commands are disabled
Error message directs users to project maintainer

conflictDetection.mode:

"abort" (default) — pull aborts when conflicts are detected
"ignore" — conflict detection disabled project-wide

CLI --conflict-mode flag always takes precedence over project config.

Example Error Message:

❌ Error: --files parameter is required for this project

Reason: Large project with 500+ objects

Usage: abapgit-agent pull --files <file1>,<file2>

This safeguard is configured in .abapgit-agent.json
Contact the project maintainer if you need to change this setting.

Parameters

Parameter	Required	Description
`--url`	No	Git repository URL (auto-detected if not specified)
`--branch`	No	Branch name (default: current branch)
`--files`	No	Comma-separated list of files to pull
`--transport`	No	Transport request (config/env takes priority if not specified)
`--conflict-mode`	No	`abort` (default) or `ignore` — see Conflict Detection
`--sync-xml`	No	Accept serializer XML output and amend last commit (see XML Sync)

Transport Request Precedence

The transport request is determined in this order:

Priority	Source	Example
1	CLI `--transport` argument	`--transport DEVK900001`
2	Config file `transport`	`"transport": "DEVK900001"` in `.abapGitAgent`
3	Environment variable `ABAP_TRANSPORT`	`export ABAP_TRANSPORT="DEVK900001"`
4 (default)	Not set	abapGit creates/uses default

XML Sync

After a successful pull, abapGit’s serializer may produce slightly different XML than the hand-crafted metadata files in git (different field presence, field order, BOM, extra sections). This causes abapGit to show the object as M (modified) even though the code itself was not changed.

The pull command detects this automatically by comparing the serializer output (get_files_local()) against the git remote files (get_files_remote()) byte-for-byte in ABAP — only files where bytes actually differ are reported.

Default (no flag): report only

⚠️  1 XML file(s) differ from serializer output:
   src/zif_my_intf.intf.xml
   Run with --sync-xml to accept serializer output and amend the last commit

`--sync-xml`: accept + amend + re-pull

abapgit-agent pull --files src/zif_my_intf.intf.abap --sync-xml

When --sync-xml is passed:

Writes the serializer XML bytes to local files (overwrite)
Stages the changed XML files: git add <files>
Amends the last commit: git commit --amend --no-edit
Pushes: git push --force-with-lease (sets upstream automatically if not yet set)
Re-pulls the same files so the ABAP system matches the amended commit

✅ Pull completed successfully!
   ...

🔄 Syncing 1 XML file(s) to match serializer output:
   src/zif_my_intf.intf.xml
   Re-pulling so ABAP system matches the amended commit...
   ...

✅ Synced 1 XML file(s), amended commit, re-pulled

Notes

Only XML metadata files (.xml) are written back — ABAP source files are untouched
Only files that already exist on disk are overwritten (no new files are created)
When --files is used, only XML files for the specified objects are compared
AI agents should always pass --sync-xml after creating or modifying ABAP objects to keep git and the ABAP system in sync

Tasks

1. Detect Git Remote URL

git remote get-url origin

2. Detect Current Branch

git branch --show-current

Or from .git/HEAD

3. Load Configuration

Read .abapGitAgent for credentials

4. Fetch CSRF Token

GET /health (with X-CSRF-Token: fetch)

5. Make Pull Request

Endpoint: POST /pull

Request Body:

{
  "url": "https://github.com/org/repo.git",
  "branch": "main",
  "username": "git-user",
  "password": "git-token",
  "files": ["zcl_my_class.clas.abap"],
  "transport_request": "DEVK900001",
  "conflict_mode": "abort"
}

6. Display Results

Output

Success

✅ Pull completed successfully!
   Message: Pull completed successfully

📋 Pull Log (N messages):
────────────────────────────────────────────────────────────────────────────────
Icon │Object                      │Message
─────┼────────────────────────────┼─────────────────────────────────────────
✅   │CLAS ZCL_MY_CLASS          │Object ZCL_MY_CLASS imported
...

📦 Activated Objects (N):
────────────────────────────────────────────────────────────────────────────────
✅ CLAS ZCL_MY_CLASS
...

With Errors

❌ Pull completed with errors!
   Message: Pull completed with errors

📋 Error Details:
────────────────────────────────────────────────────────────────────────────────
CLAS ZCL_MY_CLASS: Error updating where-used list

📋 Pull Log (N messages):
...

❌ Failed Objects Log (M entries):
────────────────────────────────────────────────────────────────────────────────
❌ CLAS ZCL_MY_CLASS: Error message text
Exception: Exception details

File Format

Files are parsed to extract (obj_type, obj_name):

File Pattern	Object Type	Object Name
`zcl_my_class.clas.abap`	CLAS	ZCL_MY_CLASS
`zif_my_intf.intf.abap`	INTF	ZIF_MY_INTF
`src/zcl_my_class.clas.abap`	CLAS	ZCL_MY_CLASS
`ztable.tabl.xml`	TABL	ZTABLE
`zdtel.dtel.xml`	DTEL	ZDTEL
`zstru.stru.xml`	STRU	ZSTRU
`src/ztable.tabl.xml`	TABL	ZTABLE

Response Structure

{
  "success": "X",
  "message": "Pull completed successfully",
  "activated_count": 15,
  "failed_count": 1,
  "activated_objects": [
    { "obj_type": "CLAS", "obj_name": "ZCL_MY_CLASS" }
  ],
  "failed_objects": [
    { "obj_type": "CLAS", "obj_name": "ZCL_OTHER", "text": "Error message" }
  ],
  "log_messages": [...],
  "conflict_report": "",
  "conflict_count": 0,
  "local_xml_files": [
    { "filename": "zcl_my_class.clas.xml", "path": "/src/", "data": "<base64>" }
  ]
}

local_xml_files contains only XML files where the serializer output differs from the git remote — empty array means all XML files are in sync.

Key Behaviors

Activated Objects - Only includes objects that completed successfully (no errors in log)
Failed Objects Log - Shows all error messages (duplicates allowed for multiple errors per object)
Error Details - When errors occur, displays error detail section at the top
Conflict Detection - Enabled by default (abort mode); aborts pull if local ADT edits or branch divergence detected — see Conflict Detection
Partial Download - --files performance depends on the abapGit version installed — see Partial Download
Missing .abapgit.xml warning - If the repository root contains no .abapgit.xml, pull prints a warning on stderr. Without this file, abapGit may use an incorrect STARTING_FOLDER from ABAP-side persistence, causing ACTIVATED_COUNT=0 with an empty log. In --json mode the result object includes "missing_abapgit_xml": true instead. Run abapgit-agent init to create the file.
XML Sync - After every successful pull, the ABAP serializer output is compared byte-for-byte against the git remote files. Differing XML files are reported as a warning; --sync-xml rewrites, amends, and re-pulls automatically.

Example

# Full pull
abapgit-agent pull

# Fast pull - specific files
abapgit-agent pull --files src/zcl_my_class.clas.abap

# With transport
abapgit-agent pull --files src/zcl_my_class.clas.abap --transport DEVK900001

# Force pull through a conflict (e.g. deliberate branch switch)
abapgit-agent pull --files src/zcl_my_class.clas.abap --conflict-mode ignore

# Sync serializer XML after creating a new object
abapgit-agent pull --files src/zif_my_intf.intf.abap --sync-xml

Overview

Pull and activate ABAP objects from git repository.

Command

# Auto-detect git remote and branch from current directory
abapgit-agent pull

# Pull specific files only (fast)
abapgit-agent pull --files src/zcl_my_class.clas.abap,src/zcl_other.clas.abap

# Pull from specific branch
abapgit-agent pull --branch develop

# Pull from specific URL
abapgit-agent pull --url https://github.com/org/repo.git

# With transport request
abapgit-agent pull --transport DEVK900001

# Combined options
abapgit-agent pull --branch develop --files src/zcl_my_class.clas.abap --transport DEVK900001

# Using transport from config/environment (no --transport flag needed)
abapgit-agent pull

Prerequisite

Current folder is git repo root (unless --url specified)
Git remote is configured (unless --url specified)
.abapGitAgent exists with valid credentials

Project-Level Safeguards

Project maintainers can configure safeguards and conflict detection defaults in .abapgit-agent.json (checked into repository):

{
  "safeguards": {
    "requireFilesForPull": true,
    "disablePull": false,
    "reason": "Large project with 500+ objects"
  },

  "conflictDetection": {
    "mode": "ignore",
    "reason": "Single-developer project"
  }
}

When requireFilesForPull: true:

abapgit-agent pull → ❌ Error: –files is required
abapgit-agent pull --files ... → ✅ Works

When disablePull: true:

All pull commands are disabled
Error message directs users to project maintainer

conflictDetection.mode:

"abort" (default) — pull aborts when conflicts are detected
"ignore" — conflict detection disabled project-wide

CLI --conflict-mode flag always takes precedence over project config.

Example Error Message:

❌ Error: --files parameter is required for this project

Reason: Large project with 500+ objects

Usage: abapgit-agent pull --files <file1>,<file2>

This safeguard is configured in .abapgit-agent.json
Contact the project maintainer if you need to change this setting.

Parameters

Parameter	Required	Description
`--url`	No	Git repository URL (auto-detected if not specified)
`--branch`	No	Branch name (default: current branch)
`--files`	No	Comma-separated list of files to pull
`--transport`	No	Transport request (config/env takes priority if not specified)
`--conflict-mode`	No	`abort` (default) or `ignore` — see Conflict Detection

Transport Request Precedence

The transport request is determined in this order:

Priority	Source	Example
1	CLI `--transport` argument	`--transport DEVK900001`
2	Config file `transport`	`"transport": "DEVK900001"` in `.abapGitAgent`
3	Environment variable `ABAP_TRANSPORT`	`export ABAP_TRANSPORT="DEVK900001"`
4 (default)	Not set	abapGit creates/uses default

Tasks

1. Detect Git Remote URL

git remote get-url origin

2. Detect Current Branch

git branch --show-current

Or from .git/HEAD

3. Load Configuration

Read .abapGitAgent for credentials

4. Fetch CSRF Token

GET /health (with X-CSRF-Token: fetch)

5. Make Pull Request

Endpoint: POST /pull

Request Body:

{
  "url": "https://github.com/org/repo.git",
  "branch": "main",
  "username": "git-user",
  "password": "git-token",
  "files": ["zcl_my_class.clas.abap"],
  "transport_request": "DEVK900001",
  "conflict_mode": "abort"
}

6. Display Results

Output

Success

✅ Pull completed successfully!
   Message: Pull completed successfully

📋 Pull Log (N messages):
────────────────────────────────────────────────────────────────────────────────
Icon │Object                      │Message
─────┼────────────────────────────┼─────────────────────────────────────────
✅   │CLAS ZCL_MY_CLASS          │Object ZCL_MY_CLASS imported
...

📦 Activated Objects (N):
────────────────────────────────────────────────────────────────────────────────
✅ CLAS ZCL_MY_CLASS
...

With Errors

❌ Pull completed with errors!
   Message: Pull completed with errors

📋 Error Details:
────────────────────────────────────────────────────────────────────────────────
CLAS ZCL_MY_CLASS: Error updating where-used list

📋 Pull Log (N messages):
...

❌ Failed Objects Log (M entries):
────────────────────────────────────────────────────────────────────────────────
❌ CLAS ZCL_MY_CLASS: Error message text
Exception: Exception details

File Format

Files are parsed to extract (obj_type, obj_name):

File Pattern	Object Type	Object Name
`zcl_my_class.clas.abap`	CLAS	ZCL_MY_CLASS
`zif_my_intf.intf.abap`	INTF	ZIF_MY_INTF
`src/zcl_my_class.clas.abap`	CLAS	ZCL_MY_CLASS
`ztable.tabl.xml`	TABL	ZTABLE
`zdtel.dtel.xml`	DTEL	ZDTEL
`zstru.stru.xml`	STRU	ZSTRU
`src/ztable.tabl.xml`	TABL	ZTABLE

Response Structure

{
  "success": "X",
  "message": "Pull completed successfully",
  "activated_count": 15,
  "failed_count": 1,
  "activated_objects": [
    { "obj_type": "CLAS", "obj_name": "ZCL_MY_CLASS" }
  ],
  "failed_objects": [
    { "obj_type": "CLAS", "obj_name": "ZCL_OTHER", "text": "Error message" }
  ],
  "log_messages": [...],
  "conflict_report": "",
  "conflict_count": 0
}

Key Behaviors

Activated Objects - Only includes objects that completed successfully (no errors in log)
Failed Objects Log - Shows all error messages (duplicates allowed for multiple errors per object)
Error Details - When errors occur, displays error detail section at the top
Conflict Detection - Enabled by default (abort mode); aborts pull if local ADT edits or branch divergence detected — see Conflict Detection
Partial Download - --files performance depends on the abapGit version installed — see Partial Download
Missing .abapgit.xml warning - If the repository root contains no .abapgit.xml, pull prints a warning on stderr. Without this file, abapGit may use an incorrect STARTING_FOLDER from ABAP-side persistence, causing ACTIVATED_COUNT=0 with an empty log. In --json mode the result object includes "missing_abapgit_xml": true instead. Run abapgit-agent init to create the file.

Example

# Full pull
abapgit-agent pull

# Fast pull - specific files
abapgit-agent pull --files src/zcl_my_class.clas.abap

# With transport
abapgit-agent pull --files src/zcl_my_class.clas.abap --transport DEVK900001

# Force pull through a conflict (e.g. deliberate branch switch)
abapgit-agent pull --files src/zcl_my_class.clas.abap --conflict-mode ignore

pull Command Requirements

Overview

Command

Prerequisite

Project-Level Safeguards

Parameters

Transport Request Precedence

XML Sync

Default (no flag): report only

--sync-xml: accept + amend + re-pull

Notes

Tasks

1. Detect Git Remote URL

2. Detect Current Branch

3. Load Configuration

4. Fetch CSRF Token

5. Make Pull Request

6. Display Results

Output

Success

With Errors

File Format

Response Structure

Key Behaviors

Example

Overview

Command

Prerequisite

Project-Level Safeguards

Parameters

Transport Request Precedence

Tasks

1. Detect Git Remote URL

2. Detect Current Branch

3. Load Configuration

4. Fetch CSRF Token

5. Make Pull Request

6. Display Results

Output

Success

With Errors

File Format

Response Structure

Key Behaviors

Example

Table of contents

`--sync-xml`: accept + amend + re-pull