Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/instructions/ci-cd-workflows.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ npm run docs:build

**Matrix Strategy:**
- **Operating Systems**: Ubuntu, Windows, macOS
- **Node.js Versions**: 20.x, 22.x, 24.x
- **Total Combinations**: 9 test runs per trigger
- **Node.js Versions**: 22.x, 24.x
- **Total Combinations**: 6 test runs per trigger

**Jobs:**

Expand All @@ -78,7 +78,7 @@ npm run docs:build
- Run linter (continue-on-error: true)
- Execute `npm run test:platform`
- Upload test results and coverage artifacts
- Upload coverage to Codecov (Ubuntu + Node 20.x only)
- Upload coverage to Codecov (Ubuntu + Node 22.x only)

**2. platform-verification** - Verify CLI installation
- Test `npm link` and `hana-cli --version`
Expand Down
6 changes: 3 additions & 3 deletions .github/instructions/project-overview.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ hana-developer-cli-tool-example/
## Technology Stack

### Runtime and Module System
- **Node.js**: ≥20.19.0 required
- **Node.js**: ≥22.0.0 required (Node.js 24 LTS highly recommended, following the SAP CAP 10 recommendation)
- **Module System**: Pure ESM (`"type": "module"` in package.json)
- **Import Pattern**: Always use `import`/`export`, never `require()`

Expand All @@ -155,7 +155,7 @@ hana-developer-cli-tool-example/
- `@cap-js/sqlite` (2.1.3) via CAP/CDS for testing and local development

### SAP Cloud Application Programming Model (CAP)
- **Core Framework**: `@sap/cds` (9.7.1)
- **Core Framework**: `@sap/cds` (10.x)
- **Extensions**:
- GraphQL: `@cap-js/graphql` (0.14.0)
- OData V2: `@cap-js-community/odata-v2-adapter` (1.15.9)
Expand Down Expand Up @@ -1130,7 +1130,7 @@ npm run changelog # Generate CHANGELOG.md from CHANGELOG.json
**File**: `scripts/postinstall.js`

**Purpose:**
- Validates Node.js version (≥20.19.0)
- Validates Node.js version (≥22.0.0)
- Checks for required dependencies
- Displays installation success message
- Shows quick start instructions
Expand Down
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## Project Overview

**hana-cli** is a developer-centric CLI tool for SAP HANA database development with 183+ commands. It supports four operating modes: CLI, interactive menu, REST API server, and MCP server (for AI assistants). It runs on Node.js ≥20.19.0 and is a pure ESM project (`"type": "module"`).
**hana-cli** is a developer-centric CLI tool for SAP HANA database development with 183+ commands. It supports four operating modes: CLI, interactive menu, REST API server, and MCP server (for AI assistants). It targets SAP CAP 10 and runs on Node.js ≥22.0.0 (Node.js 24 LTS highly recommended, following the CAP 10 recommendation). It is a pure ESM project (`"type": "module"`).

## Commands

Expand Down Expand Up @@ -97,7 +97,7 @@ Most commands share: `--schema`/`-s` (defaults to `**CURRENT_SCHEMA**`), `--tabl
- Config: `tests/.mocharc.json` (16 parallel jobs, 10s timeout)
- Mocking: `sinon` + `esmock` for ESM mocking, `mock-fs` for filesystem, `supertest` for HTTP routes
- Coverage threshold: 80% lines/functions/branches (enforced in CI via `npm run coverage:check`)
- Cross-platform CI: Windows/macOS/Ubuntu × Node 20/22/24 in `.github/workflows/cross-platform-tests.yml`
- Cross-platform CI: Windows/macOS/Ubuntu × Node 22/24 in `.github/workflows/cross-platform-tests.yml`

## Development Guides

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ graph LR

Otherwise you can also run it from the sources as described here:

- Install Node.js version 20.19.0 or later on your development machine [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
- Install Node.js on your development machine [https://nodejs.org/en/download/](https://nodejs.org/en/download/). Version 22 or later is required; **Node.js 24 (LTS) is highly recommended**, following the SAP CAP 10 recommendation.

- Clone the repository from [https://github.com/SAP-samples/hana-developer-cli-tool-example](https://github.com/SAP-samples/hana-developer-cli-tool-example)

Expand Down
2 changes: 1 addition & 1 deletion agent-instructions/HANA_CLI_QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# hana-cli Quick Start Guide

> Generated from hana-cli v4.202603.2 on 2026-03-17
> Generated from hana-cli v4.202607.0 on 2026-07-13

## Install

Expand Down
48 changes: 46 additions & 2 deletions agent-instructions/HANA_CLI_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SAP HANA CLI (hana-cli) — Complete Command Reference

> Generated from hana-cli v4.202603.2 on 2026-03-17
> Generated from hana-cli v4.202607.0 on 2026-07-13
> This file is auto-generated. Do not edit manually.

## What is hana-cli?
Expand All @@ -13,7 +13,7 @@
npm install -g hana-cli
```

**Requirements:** Node.js ≥ 20.19.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)

### Connection Setup

Expand Down Expand Up @@ -1020,6 +1020,33 @@ Developer utilities, templates, docs, and interactive helpers

---

#### `mcpServerInstall`

**Aliases:** `mcp`, `mcpInstall`, `mcp-install`
**Syntax:** `hana-cli mcpServerInstall`

**Parameters:**

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--client` (`-c`) | string | `'auto'` | client |
| `--name` (`-n`) | string | `'hana-cli'` | name |
| `--dryRun` (`--dr`) | boolean | `false` | dryRun |
| `--global` (`-g`) | boolean | `false` | global |

**Related:** `mcpServerStatus`, `helpDocu`

---

#### `mcpServerStatus`

**Aliases:** `mcp-status`, `mcpStatus`
**Syntax:** `hana-cli mcpServerStatus`

**Related:** `mcpServerInstall`, `helpDocu`

---

#### `readMe`

**Aliases:** `readme`
Expand Down Expand Up @@ -1840,6 +1867,20 @@ Inspect tables, views, procedures, indexes, and related objects
**Syntax:** `hana-cli commandMap`


---

#### `vscode`

**Aliases:** `code`, `extension`
**Syntax:** `hana-cli vscode [action]`

**Parameters:**

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--insiders` | boolean | `false` | Use code-insiders instead of code |


---

### Performance Monitoring
Expand Down Expand Up @@ -3417,6 +3458,8 @@ Diagnose and investigate system problems
| `massRename` (mr, massrename, massRN, massrn) | Mass Operations | Rename objects in bulk |
| `massUpdate` (mu, massupdate, massUpd, massupd) | Mass Operations | Update many records at once |
| `massUsers` (massUser, mUsers, mUser, mu) | Mass Operations | Mass Operations |
| `mcpServerInstall` (mcp, mcpInstall, mcp-install) | Developer Tools | Developer Tools |
| `mcpServerStatus` (mcp-status, mcpStatus) | Developer Tools | Developer Tools |
| `memoryAnalysis` | Performance Monitoring | Analyze memory consumption |
| `memoryLeaks` (memleak, ml) | Performance Monitoring | Find potential memory leaks |
| `objects` (o, listObjects, listobjects) | Schema Tools | List all database objects |
Expand Down Expand Up @@ -3465,5 +3508,6 @@ Diagnose and investigate system problems
| `version` | System Tools | Check HANA version |
| `viewDocs` (docs, doc, documentation) | Developer Tools | Developer Tools |
| `views` (v, listViews, listviews) | Schema Tools | List views |
| `vscode` (code, extension) | Other | Other |
| `workloadManagement` (wlm, workloads, workloadClass, workloadmgmt) | System Admin | Manage workload assignments |
| `xsaServices` (xsa, xsaSvc, xsaservices) | System Admin | Manage XSA services |
2 changes: 1 addition & 1 deletion agent-instructions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ node scripts/generate-agent-instructions.js --force

## Version

Generated from **hana-cli v4.202603.2** on 2026-03-17.
Generated from **hana-cli v4.202607.0** on 2026-07-13.
27 changes: 27 additions & 0 deletions agent-instructions/categories/developer-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Developer utilities, templates, docs, and interactive helpers
| `interactive` | `i`, `repl`, `shell` | - |
| `issue` | `Issue`, `openIssue`, `openissue`, `reportIssue`, `reportissue` | Report issues or get help |
| `kb` | - | - |
| `mcpServerInstall` | `mcp`, `mcpInstall`, `mcp-install` | - |
| `mcpServerStatus` | `mcp-status`, `mcpStatus` | - |
| `readMe` | `readme` | View help documentation |
| `readMeUI` | `readmeui`, `readMeUi`, `readmeUI` | - |
| `sdiTasks` | `sditasks`, `sdi`, `smartDataIntegration` | Manage SDI tasks |
Expand Down Expand Up @@ -178,6 +180,31 @@ hana-cli kb [query...]

---

## `mcpServerInstall`

**Aliases:** `mcp`, `mcpInstall`, `mcp-install`

### Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--client` (`-c`) | string | `'auto'` | client |
| `--name` (`-n`) | string | `'hana-cli'` | name |
| `--dryRun` (`--dr`) | boolean | `false` | dryRun |
| `--global` (`-g`) | boolean | `false` | global |

**Related:** `mcpServerStatus`, `helpDocu`

---

## `mcpServerStatus`

**Aliases:** `mcp-status`, `mcpStatus`

**Related:** `mcpServerInstall`, `helpDocu`

---

## `readMe`

**Aliases:** `readme`
Expand Down
18 changes: 18 additions & 0 deletions agent-instructions/categories/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,27 @@
| Command | Aliases | Description |
|---------|---------|-------------|
| `commandMap` | - | - |
| `vscode` | `code`, `extension` | - |

## `commandMap`



---

## `vscode`

```bash
hana-cli vscode [action]
```

**Aliases:** `code`, `extension`

### Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--insiders` | boolean | `false` | Use code-insiders instead of code |


---
4 changes: 2 additions & 2 deletions agent-instructions/claude/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
4 changes: 2 additions & 2 deletions agent-instructions/cline/.clinerules
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
4 changes: 2 additions & 2 deletions agent-instructions/copilot/.github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ applyTo: "*.hdbcds,*.hdbtable,*.hdbview,*.hdbprocedure,*.hdbfunction,*.cds,mta.y

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
4 changes: 2 additions & 2 deletions agent-instructions/cursor/.cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
4 changes: 2 additions & 2 deletions agent-instructions/generic/AGENT_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
5 changes: 4 additions & 1 deletion agent-instructions/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> SAP HANA Developer CLI Tool — simplifies database development operations

## Install: npm install -g hana-cli
## Version: 4.202603.2
## Version: 4.202607.0
## Docs: https://github.com/SAP-samples/hana-developer-cli-tool-example

## Commands
Expand Down Expand Up @@ -128,6 +128,8 @@
- massRename (mr, massrename, massRN, massrn): Rename objects in bulk
- massUpdate (mu, massupdate, massUpd, massupd): Update many records at once
- massUsers (massUser, mUsers, mUser, mu): Mass Operations
- mcpServerInstall (mcp, mcpInstall, mcp-install): Developer Tools
- mcpServerStatus (mcp-status, mcpStatus): Developer Tools
- memoryAnalysis: Analyze memory consumption
- memoryLeaks (memleak, ml): Find potential memory leaks
- objects (o, listObjects, listobjects): List all database objects
Expand Down Expand Up @@ -176,6 +178,7 @@
- version: Check HANA version
- viewDocs (docs, doc, documentation): Developer Tools
- views (v, listViews, listviews): List views
- vscode (code, extension): Other
- workloadManagement (wlm, workloads, workloadClass, workloadmgmt): Manage workload assignments
- xsaServices (xsa, xsaSvc, xsaservices): Manage XSA services

Expand Down
2 changes: 1 addition & 1 deletion agent-instructions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@
"author": "SAP",
"license": "Apache-2.0",
"engines": {
"node": ">=18.0.0"
"node": ">=22.0.0"
}
}
4 changes: 2 additions & 2 deletions agent-instructions/windsurf/.windsurfrules
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

hana-cli (npm: hana-cli, install: `npm install -g hana-cli`) is a command-line tool for SAP HANA database development. It simplifies complex multi-step database operations into single commands. It is a development tool, not a replacement for hdbsql or production admin tools.

**Version:** 4.202603.2
**Requirements:** Node.js ≥ 20.19.0
**Version:** 4.202607.0
**Requirements:** Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
**Module:** ESM (`"type": "module"`)

## When to Use hana-cli
Expand Down
2 changes: 1 addition & 1 deletion docs/01-getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ npm link

**Requirements:**

- [Node.js 20.19.0 or later](https://nodejs.org/)
- [Node.js 22 or later](https://nodejs.org/) — **Node.js 24 (LTS) highly recommended** (follows SAP CAP 10 guidance)
- Access to a SAP HANA database instance

[Full Installation Guide →](./installation.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/01-getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ See the [Changelog](/99-reference/changelog) for complete details on all changes

## Prerequisites

- **Node.js**: Version 20.19.0 or later
- **Node.js**: Version 22.0.0 or later required; **Node.js 24 (LTS) is highly recommended** (aligns with the SAP CAP 10 recommendation)
- Download from [nodejs.org](https://nodejs.org/)
- Verify: `node --version`

Expand Down
2 changes: 1 addition & 1 deletion docs/03-features/mcp/server-implementation-complete.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ npm run build
- **MCP Server Version:** 1.202602.0
- **Main CLI Version:** 4.202602.0
- **MCP SDK:** ^1.26.0
- **Node.js:** ≥20.19.0
- **Node.js:** ≥22.0.0 (Node.js 24 LTS recommended)
- **TypeScript:** ^5.7.3

## Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/03-features/mcp/server-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The MCP server now properly exposes and documents all new commands added in rece
## Version Compatibility

- **MCP SDK:** ^1.26.0
- **Node.js:** ≥20.19.0 (matching parent project)
- **Node.js:** ≥22.0.0, Node.js 24 LTS recommended (matching parent project)
- **TypeScript:** ^5.7.3
- **CLI Version:** 4.202602.0 and later

Expand Down
Loading
Loading