abapgit-agent 1.0.0 → 1.0.1

package/docs/commands.md

@@ -0,0 +1,107 @@
+# Commands Overview
+
+All available CLI commands for abapGit Agent.
+
+## Command Reference
+
+| Command | Status | Description | File |
+|---------|--------|-------------|------|
+| [init](init-command.md) | ✅ | Initialize local configuration | Initialize local configuration for git repo |
+| [create](create-command.md) | TODO | Create online repository | Create abapGit repo in ABAP system |
+| [pull](pull-command.md) | ✅ | Pull and activate | Pull objects from git and activate in ABAP |
+| [inspect](inspect-command.md) | ✅ | Syntax check | Check ABAP source files for errors |
+| [unit](unit-command.md) | ✅ | Run unit tests | Execute AUnit tests |
+| [health](health-command.md) | ✅ | Health check | Verify ABAP REST API is accessible |
+| [status](status-command.md) | ✅ | Status check | Check if configured for current repo |
+
+---
+
+## Implemented Commands
+
+### Daily Development
+
+```bash
+# Pull changes (auto-detects git remote)
+abapgit-agent pull
+
+# Syntax check before commit
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Run tests
+abapgit-agent unit --files abap/zcl_my_test.clas.testclasses.abap
+
+# Check configuration
+abapgit-agent status
+
+# Verify ABAP connection
+abapgit-agent health
+```
+
+---
+
+## TODO Commands (Not Yet Implemented)
+
+### New Project Setup
+
+```bash
+# 1. Initialize local configuration
+abapgit-agent init --folder /src --package ZMY_PACKAGE
+
+# 2. Edit .abapGitAgent with credentials
+vim .abapGitAgent
+
+# 3. Create online repo and import existing objects
+abapgit-agent create --import
+
+# 4. Push to git
+git push
+
+# 5. Activate in ABAP
+abapgit-agent pull
+```
+
+---
+
+## Planned Command Flow
+
+```
+┌─────────────────────────────────────────────────┐
+│  init                                           │  ← TODO
+│  └── Creates .abapGitAgent, CLAUDE.md, /src/   │
+└─────────────────────────────────────────────────┘
+                        │
+                        ▼
+┌─────────────────────────────────────────────────┐
+│  create --import                                │  ← TODO
+│  └── Creates repo in ABAP, imports objects     │
+└─────────────────────────────────────────────────┘
+                        │
+                        ▼
+┌─────────────────────────────────────────────────┐
+│  git push                                       │
+└─────────────────────────────────────────────────┘
+                        │
+                        ▼
+┌─────────────────────────────────────────────────┐
+│  pull                                          │
+│  └── Activates objects in ABAP                  │
+└─────────────────────────────────────────────────┘
+```
+
+---
+
+## Common Options
+
+### Global Parameters
+
+All commands read configuration from:
+- `.abapGitAgent` file in current directory
+- Environment variables (`ABAP_HOST`, `ABAP_USER`, etc.)
+
+### File Patterns
+
+| Pattern | Description |
+|---------|-------------|
+| `zcl_my_class.clas.abap` | ABAP class source |
+| `zif_my_intf.intf.abap` | ABAP interface source |
+| `zcl_my_test.clas.testclasses.abap` | ABAP test class |

package/docs/create-command.md

@@ -0,0 +1,211 @@
+# create Command Requirements
+
+## Overview
+
+> **TODO**: This command is not yet implemented.
+
+Create a new abapGit online repository in the ABAP system.
+
+## Command
+
+```bash
+# Create online repo only
+abapgit-agent create
+
+# Create online repo and import existing objects
+abapgit-agent create --import
+```
+
+## Prerequisite
+
+- `init` command has been run successfully
+- `.abapGitAgent` file exists
+- User has edited `.abapGitAgent` with correct credentials (host, user, password)
+- Current folder is git repo root
+
+## Parameters
+
+| Parameter | Required | Description |
+|-----------|----------|-------------|
+| `--import` | No | Import existing objects from package to git repo |
+
+---
+
+## Tasks
+
+### 1. Validate Configuration
+
+```bash
+abapgit-agent status
+```
+
+- Verify `.abapGitAgent` exists
+- Verify git repo is configured
+
+```bash
+abapgit-agent health
+```
+
+- Verify ABAP connection is healthy
+
+### 2. Read Configuration
+
+Read `.abapGitAgent` and extract:
+- `host`, `sapport`, `client`, `user`, `password`, `language`
+- `package`
+- `folder`
+
+### 3. Get Git Remote URL
+
+```bash
+git remote get-url origin
+```
+
+### 4. Create abapGit Online Repository
+
+**Endpoint:** `POST /create`
+
+**Request Body:**
+```json
+{
+  "url": "https://github.com/org/repo.git",
+  "package": "ZMY_PACKAGE",
+  "folder_logic": "FULL",
+  "folder": "/src"
+}
+```
+
+### 5. If `--import`: Pull Existing Objects
+
+- Use `folder` from `.abapGitAgent`
+- Pull existing objects from package (no objects if package is empty)
+- Write files to folder
+- Git commit
+
+---
+
+## Output
+
+### Success (without --import)
+
+```
+✅ Online repository created successfully
+   URL: https://github.com/org/repo.git
+   Package: ZMY_PACKAGE
+   Name: repo
+
+Next steps:
+   abapgit-agent pull
+```
+
+### Success (with --import)
+
+```
+✅ Online repository created successfully
+   URL: https://github.com/org/repo.git
+   Package: ZMY_PACKAGE
+   Name: repo
+
+✅ Objects imported from package
+   Files: 15
+   Commit: feat: initial import from ABAP package ZMY_PACKAGE
+
+Next steps:
+   git push
+   abapgit-agent pull
+```
+
+---
+
+## Error Handling
+
+| Error | Message |
+|-------|---------|
+| No .abapGitAgent | Run `init` command first |
+| Missing credentials | Edit .abapGitAgent (host, user, password) |
+| Health check failed | Check ABAP system connection |
+| Repo already exists | Repository already exists in ABAP |
+| Package not found | Package ZMY_PACKAGE does not exist |
+| API error | Failed to create repository |
+
+---
+
+## Full Workflow
+
+```
+1. abapgit-agent init --folder /src --package ZMY_PACKAGE
+   └─> Creates .abapGitAgent, CLAUDE.md, /src/
+
+2. Edit .abapGitAgent (host, user, password)
+
+3. abapgit-agent online --import
+   └─> Creates repo in ABAP, imports objects, commits
+
+4. git push origin main
+
+5. abapgit-agent pull
+   └─> Activates objects in ABAP
+```
+
+## Example
+
+```bash
+# Initialize
+abapgit-agent init --folder /abap --package ZMYPROJECT
+
+# Edit config
+vim .abapGitAgent
+
+# Create online repo with import
+abapgit-agent online --import
+
+# Push to git
+git push origin main
+
+# Activate in ABAP
+abapgit-agent pull
+```
+
+## API Reference
+
+### Create Online Repository
+
+**Endpoint:** `POST /create`
+
+**Request:**
+```
+POST /online
+Content-Type: application/json
+
+{
+  "url": "https://github.com/org/repo.git",
+  "package": "ZMY_PACKAGE",
+  "folder_logic": "FULL",
+  "folder": "/src"
+}
+```
+
+**Response:**
+```
+HTTP/2 201 Created
+Content-Type: application/json
+
+{
+  "key": "REPO_KEY_123",
+  "url": "https://github.com/org/repo.git",
+  "package": "ZMY_PACKAGE",
+  "name": "repo"
+}
+```
+
+### Error Response
+
+```
+HTTP/4xx
+Content-Type: application/json
+
+{
+  "error": "Repository already exists",
+  "message": "Repository with URL https://github.com/org/repo.git already exists"
+}
+```

package/docs/health-command.md

@@ -0,0 +1,89 @@
+# health Command Requirements
+
+## Overview
+
+Check if the ABAP REST API is healthy and accessible.
+
+## Command
+
+```bash
+abapgit-agent health
+```
+
+## Prerequisite
+
+- `.abapGitAgent` file exists with valid credentials, or environment variables are set
+
+## Tasks
+
+### 1. Load Configuration
+
+Read from `.abapGitAgent` or environment variables:
+- `host`
+- `sapport`
+- `client`
+- `user`
+- `password`
+- `language`
+
+### 2. Make Health Check Request
+
+**Endpoint:** `GET /health`
+
+**Response:**
+```json
+{
+  "status": "healthy",
+  "abap": "connected",
+  "version": "1.0.0"
+}
+```
+
+### 3. Display Result
+
+```bash
+$ abapgit-agent health
+{
+  "status": "healthy",
+  "abap": "connected",
+  "version": "1.0.0"
+}
+```
+
+---
+
+## Output
+
+| Status | Output |
+|--------|--------|
+| Healthy | JSON response with status |
+| Error | Error message with details |
+
+---
+
+## Error Handling
+
+| Error | Message |
+|-------|---------|
+| Connection failed | `Health check failed: <error message>` |
+| Invalid credentials | Authentication error |
+
+---
+
+## Example
+
+```bash
+# Check health
+abapgit-agent health
+
+# Output
+{
+  "status": "healthy",
+  "abap": "connected",
+  "version": "1.0.0"
+}
+```
+
+## Used By
+
+- `create` command - validates ABAP connection before creating repo

package/docs/import-command.md

@@ -0,0 +1,196 @@
+# import Command
+
+Import existing ABAP objects from a package into an existing abapGit online repository.
+
+## Command
+
+```bash
+abapgit-agent import
+abapgit-agent import --message "Your commit message"
+```
+
+## Prerequisites
+
+- Repository already exists in ABAP (created via abapGit UI or `create` command)
+- Package has objects to import
+- GitHub credentials configured in `.abapGitAgent`
+
+## Parameters
+
+| Parameter | Required | Default | Description |
+|-----------|----------|---------|-------------|
+| `--message` | No | `feat: initial import from ABAP package <package>` | Commit message |
+| `--help` | No | - | Show help |
+
+## Configuration
+
+### .abapGitAgent
+
+Add GitHub credentials to `.abapGitAgent`:
+
+```json
+{
+  "gitUsername": "I045696",
+  "gitPassword": "ghp_your_github_token"
+}
+```
+
+### Environment Variables
+
+```bash
+export GIT_USERNAME="I045696"
+export GIT_PASSWORD="ghp_your_github_token"
+```
+
+### GitHub Personal Access Token
+
+1. Create a PAT at:
+   - GitHub.com: https://github.com/settings/tokens
+   - GitHub Enterprise: https://github.tools.sap/settings/tokens
+
+2. Select scopes:
+   - `repo` - Full control of private repositories
+   - Or `public_repo` if your repo is public
+
+## How It Works
+
+1. **Validate** - Check repository URL exists
+2. **Find Repo** - Locate abapGit repository by git URL
+3. **Configure Credentials** - Set git credentials from config
+4. **Refresh** - Get latest local files from package
+5. **Stage** - Create stage with all files
+6. **Commit** - Commit with message
+7. **Push** - Push to remote
+
+## Workflow
+
+### Full Development Cycle
+
+```
+1. Develop in ABAP (SAP GUI, ADT)
+   └─> Create/modify objects in package
+
+2. abapgit-agent import
+   └─> Stages, commits, and pushes to git
+
+3. git pull (optional, in local repo)
+   └─> Get files to local folder
+
+4. Repeat
+```
+
+## Output
+
+### Success
+
+```
+✅ Objects imported successfully!
+   Files staged: 27
+   Commit: feat: initial import from ABAP package AUD_TAG
+```
+
+### With Custom Message
+
+```
+✅ Objects imported successfully!
+   Files staged: 15
+   Commit: My custom import message
+```
+
+### Error - Repository Not Found
+
+```
+❌ Import failed
+   Error: Repository not found. Run "abapgit-agent create" or create in abapGit UI first.
+```
+
+### Error - No Objects Found
+
+```
+❌ Import failed
+   Error: No objects found in package ZMY_PACKAGE
+```
+
+### Error - GitHub Credentials
+
+```
+❌ Import failed
+   Error: Unauthorized access to resource (HTTP 401)
+```
+
+## Troubleshooting
+
+### HTTP 401 Unauthorized
+
+GitHub credentials not configured or invalid:
+
+1. Create a GitHub Personal Access Token
+2. Add to `.abapGitAgent`:
+
+```json
+{
+  "gitUsername": "I045696",
+  "gitPassword": "ghp_your_token"
+}
+```
+
+### Repository Not Found
+
+The repository must exist in abapGit:
+
+1. Run `abapgit-agent create` to create it, OR
+2. Create manually in abapGit UI: https://<sap>/sap/bc/zabapgit
+
+### No Objects Found
+
+The package may be empty or objects not yet created:
+
+1. Verify package in SAP GUI: `SE21` → Display Package
+2. Ensure objects exist in the package
+
+## Full Workflow
+
+### Option 1: abapgit-agent (Recommended)
+
+```bash
+# Initialize
+abapgit-agent init --folder /abap --package ZMYPROJECT
+
+# Edit config
+vim .abapGitAgent
+
+# Create repository
+abapgit-agent create
+
+# Develop objects in ABAP...
+
+# Import objects to git
+abapgit-agent import
+
+# Pull to local folder
+git pull origin main
+```
+
+### Option 2: abapGit UI for Creation
+
+```bash
+# Initialize
+abapgit-agent init --folder /abap --package ZMYPROJECT
+
+# Edit config
+vim .abapGitAgent
+
+# Create repository in abapGit UI
+# https://<sap>/sap/bc/zabapgit → New → Online → Enter git URL
+
+# Develop objects in ABAP...
+
+# Import objects to git
+abapgit-agent import
+```
+
+## Related Commands
+
+- [`init`](init-command.md) - Initialize local configuration
+- [`create`](create-command.md) - Create online repository in ABAP
+- [`pull`](pull-command.md) - Pull and activate objects in ABAP