abapgit-agent 1.0.0

package/INSTALL.md

@@ -0,0 +1,160 @@
+# Installation & Setup
+
+## Architecture
+
+```
+Claude (VS Code) → CLI Tool → ABAP System (REST/HTTP)
+                                  ↓
+                    Result + Error Feedback
+```
+
+## Components
+
+### ABAP Side - REST Implementation
+
+| File | Type | Description |
+|------|------|-------------|
+| `zif_abgagt_agent.intf.abap` | Interface | Type definitions and method signatures |
+| `zcl_abgagt_agent.clas.abap` | Class | Main agent with `pull`, `inspect`, `run_tests` methods |
+| `zcl_abgagt_rest_handler.clas.abap` | Class | REST router for endpoints |
+| `zcl_abgagt_resource_pull.clas.abap` | Class | POST /pull handler |
+| `zcl_abgagt_resource_inspect.clas.abap` | Class | POST /inspect handler |
+| `zcl_abgagt_resource_unit.clas.abap` | Class | POST /unit handler |
+| `zcl_abgagt_resource_health.clas.abap` | Class | GET /health handler |
+
+**Note:** Error details are returned directly in the REST response via `error_detail` field.
+
+### CLI Tool (Node.js)
+- REST client for ABAP communication
+- Configuration management (reads from cwd/.abapGitAgent)
+- Auto-detects git remote URL and branch from current directory
+- Cookie-based session management
+
+## Why REST API?
+
+The REST API approach provides several advantages:
+- **No OData/Gateway needed** - Simpler setup
+- **Standard HTTP** - Easy to debug and test
+- **No SEGW required** - Direct ICF handler
+- **No native dependencies** - Works on any OS
+
+## ABAP System Setup
+
+### Prerequisites
+
+The developer version of abapGit is required to deploy the REST handler. Follow the [abapGit developer version installation guide](https://docs.abapgit.org/user-guide/getting-started/install.html#install-developer-version).
+
+### Deploy ABAP Objects
+
+Deploy ABAP objects using abapGit:
+
+1. Use abapGit to deploy the ABAP objects in `/abap` folder
+2. Create SICF handler:
+   - Run transaction `SICF`
+   - Navigate to: `sap/bc/z_abapgit_agent`
+   - Create if doesn't exist:
+     - Right-click on `sap/bc` → **Create Element**
+     - **Service Name**: `Z_ABAPGIT_AGENT`
+     - **Handler Class**: `ZCL_ABGAGT_REST_HANDLER`
+   - Activate the service
+
+## CLI Installation
+
+```bash
+# Option A: Install globally for system-level integration
+sudo npm link
+
+# Option B: Use from cloned repo
+cd abapgit-agent
+npm install
+```
+
+## Configuration
+
+Copy `.abapGitAgent.example` to `.abapGitAgent` in your repository root:
+
+```bash
+cp .abapGitAgent.example .abapGitAgent
+```
+
+### Configuration Options
+
+**File-based** (.abapGitAgent):
+```json
+{
+  "host": "your-sap-system.com",
+  "sapport": 443,
+  "client": "100",
+  "user": "TECH_USER",
+  "password": "your-password",
+  "language": "EN",
+  "gitUsername": "github-username",
+  "gitPassword": "github-token"
+}
+```
+
+**Environment variables**:
+- `ABAP_HOST`, `ABAP_PORT`, `ABAP_CLIENT`, `ABAP_USER`, `ABAP_PASSWORD`
+
+## System-Level Integration
+
+This package supports **system-level integration**, meaning any ABAP git repository can use it without cloning this repository:
+
+1. **Install globally**: `sudo npm link`
+2. **Configure**: Add `.abapGitAgent` to your ABAP repo
+3. **Use**: Run `abapgit-agent` from your repo directory
+
+## Creating New ABAP Projects
+
+### 1. Create Project Structure
+
+```bash
+# Create new ABAP repository
+mkdir my-abap-repo
+cd my-abap-repo
+
+# Copy CLAUDE.md (tells Claude how to work with ABAP)
+cp /path/to/abapgit-agent/abap/CLAUDE.md .
+
+# Initialize git
+git init
+```
+
+### 2. Add ABAP Objects
+
+Copy your ABAP objects to the repo:
+
+```bash
+# Copy individual objects
+cp /path/to/abapgit-agent/abap/zcl_*.abap ./
+```
+
+### 3. Configure and Push
+
+```bash
+# Create .abapGitAgent config
+cp .abapGitAgent.example .abapGitAgent
+# Edit .abapGitAgent with your SAP system details
+
+# Initial commit
+git add .
+git commit -m "Initial ABAP project"
+
+# Add remote and push
+git remote add origin https://github.com/user/my-abap-repo.git
+git push -u origin main
+```
+
+### 4. Deploy to SAP
+
+Use abapGit in your SAP system to pull the repository.
+
+## Claude Code Integration
+
+Claude Code automatically reads `CLAUDE.md` in your project root for context:
+
+1. **No local syntax validation** - Claude knows ABAP needs SAP system
+2. **Use `abapgit-agent pull`** - For validation after code generation
+3. **Reference local docs** - See CLAUDE_MEM.md for knowledge management
+
+See `abap/CLAUDE.md` for detailed ABAP project guidelines.

package/README.md

@@ -0,0 +1,127 @@
+# abapGit Agent
+
+A local agent that enables AI coding tools (Claude, Copilot, etc.) to automatically pull and activate ABAP code from git repositories using REST API.
+
+## Overview
+
+This project provides a bridge between AI coding tools and your ABAP system:
+
+1. **Claude generates ABAP code** → Push to git
+2. **Local agent pulls from git** → Activates in ABAP system
+3. **Returns activation results** → Claude fixes errors if any
+
+![Claude using abapgit-agent](img/claude.png)
+
+## Quick Start
+
+1. **Install CLI**: From this repo, run `sudo npm link`
+2. **Configure repo**: Add `.abapGitAgent` with SAP credentials
+3. **Validate code**: Run `abapgit-agent pull` after pushing
+
+See [Creating New ABAP Projects](INSTALL.md#creating-new-abap-projects) to set up a new ABAP repository with Claude Code integration.
+
+## CLI Commands
+
+```bash
+# Pull and activate (auto-detects git remote and branch)
+abapgit-agent pull
+
+# Pull with specific branch
+abapgit-agent pull --branch develop
+
+# Pull specific files only (fast iteration)
+abapgit-agent pull --files zcl_my_class.clas.abap,zif_my_intf.intf.abap
+
+# Override git URL if needed
+abapgit-agent pull --url https://github.com/user/repo --branch main
+
+# Pull with a specific transport request
+abapgit-agent pull --transport DEVK900001
+
+# Combine options: files + transport request
+abapgit-agent pull --files zcl_my_class.clas.abap --transport DEVK900001
+
+# Inspect source file for issues
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Run AUnit tests for test classes
+abapgit-agent unit --files abap/zcl_my_test.clas.testclasses.abap
+
+# Run tests for multiple test classes
+abapgit-agent unit --files abap/zcl_test1.clas.testclasses.abap,abap/zcl_test2.clas.testclasses.abap
+
+# Health check
+abapgit-agent health
+
+# Check integration status
+abapgit-agent status
+```
+
+## Local Development
+
+```bash
+# Install dependencies
+cd abapgit-agent
+npm install
+
+# Run from package directory (auto-detects from git)
+node bin/abapgit-agent pull
+
+# Or use npm script
+npm run pull -- --url <git-url> --branch main
+```
+
+## Unit Tests
+
+Run AUnit tests for ABAP test classes and view detailed results:
+
+```bash
+# Run unit tests for a test class file
+abapgit-agent unit --files abap/zcl_my_test.clas.testclasses.abap
+
+# Run tests for multiple test classes
+abapgit-agent unit --files abap/zcl_test1.clas.testclasses.abap,abap/zcl_test2.clas.testclasses.abap
+```
+
+### Output
+
+Success case:
+```
+✅ ZCL_MY_TEST - All tests passed
+   Tests: 10 | Passed: 10 | Failed: 0
+```
+
+Failure case with details:
+```
+❌ ZCL_MY_TEST - Tests failed
+   Tests: 10 | Passed: 8 | Failed: 2
+   ✗ ZCL_MY_TEST=>TEST_METHOD_1: Error description
+   ✗ ZCL_MY_TEST=>TEST_METHOD_2: Another error
+```
+
+### Supported File Formats
+
+| File Pattern | Description |
+|--------------|-------------|
+| `zcl_my_test.clas.testclasses.abap` | Test class file |
+| `src/tests/zcl_my_test.clas.testclasses.abap` | With subdirectory path |
+
+## Documentation
+
+| Topic | File |
+|-------|------|
+| Installation & Setup | [INSTALL.md](INSTALL.md) |
+| REST API Reference | [API.md](API.md) |
+| Error Handling | [ERROR_HANDLING.md](ERROR_HANDLING.md) |
+| ABAP Coding Guidelines | [abap/CLAUDE.md](abap/CLAUDE.md) |
+| claude-mem Knowledge Management | [CLAUDE_MEM.md](CLAUDE_MEM.md) |
+
+## Dependent Projects
+
+This tool depends on and is designed to work with:
+
+- [abapGit](https://github.com/abapGit/abapGit) - The foundation for managing ABAP code in git
+
+## License
+
+MIT License