onedevatlasBeta
Browse the atlas
AllCAPBTPUI5ABAP
CLICLItypeA command you run, rather than a dependency you import.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →

SAP-samples/hana-developer-cli-tool-example

A developer-centric command line for SAP HANA, built for local development outside SAP tooling and connecting to a local, cloud or remote HANA instance the same way.

hdbsql already gives a generic SQL console; this groups the commands developers otherwise script by hand into over 200 named commands for connecting, inspecting, exporting and comparing schemas, tables and views, and for managing BTP resources such as HDI containers through a bundled wrapper around the btp CLI. It reads connectivity from a default-env.json the way local SAP HANA development already does, so it runs unchanged from a laptop, SAP Business Application Studio, a cloud shell, or against a SAP HANA Cloud instance. A --web flag starts a Fiori launchpad and a documented REST API over the same commands, and a bundled Model Context Protocol server exposes a discoverable subset that grows from around 22 tools to the full command set on demand, so an AI assistant can query and inspect the database in natural language through the same connection.

GitHub114 ★
npm
Homepage

Facts

Last pushLicenceApache-2.0

Where it sits

Lives in
BTP/BAIP
Provides
Agent access to your systemsBTPCAPAgent access to your systemscapabilityGiving an AI agent access to the business data, configuration or operations of systems you run through an MCP server. [Serving your application over MCP](capability:mcp-servers) exposes your own service contract; system access reaches the systems behind it, and one implementation may do both. Development assistance belongs to [agent access to your code](capability:agent-code-access).Native SAP HANA artifactsCAPNative SAP HANA artifactscapabilityUsing native SAP HANA database objects alongside an application’s generated data model, including objects and database features the modelling layer cannot express. Choosing a database is [database connectors](capability:database-connectors); changing an existing schema is [schema evolution](capability:schema-evolution).Database administrationBTPDatabase administrationcapabilityRunning the database a project uses once it exists: watching its health and performance, managing users and their access privileges, and keeping backups that a recovery can rest on. Connecting an application to the database is [database connectors](capability:database-connectors), moving files in and out of tables is [importing and exporting table data](capability:data-import-export), and what the instance costs is [consumption monitoring](capability:consumption-monitoring).
Serves
CAP

Who is behind it

SAP SamplesSAP SamplesOrganisationMaintains this
In the atlas: maintains 222@SAP-samplesmaintainerHP SeitzPersonContributes to this
In the atlas: contributes to 1@6of5Ajinkya PatilPersonContributes to this
In the atlas: contributes to 112@ajinkyapatil8190Brian BernardPersonContributes to this
In the atlas: contributes to 64@btbernardGregor WolfPersonContributes to this
In the atlas: maintains 17, contributes to 59, wrote 2@gregorwolfThomas JungPersonContributes to this
Developer Advocate
In the atlas: contributes to 15, wrote 6@jung-thomasJoerg MeyerPersonContributes to this
In the atlas: contributes to 1@Meyer-JSamuele BarzaghiPersonContributes to this
In the atlas: contributes to 2@sbarzaghialteaupPetr PlenkovPersonContributes to this
In the atlas: contributes to 13@ThePlenkov8 contributors

Before choosing this

Conditions

PolicySAP API Policy 4.2026a§ 1.1, 1.2, 2.2.2from Agent access to your systemsAn MCP server uses SAP APIs to supply tools, resources or data to an agent.
  • § 1.1 Published APIs. Published APIs are made available for the documented purposes identified by SAP, including integration, extensions and data exchange.
  • § 1.2 Non-Published APIs. Customer and third-party applications must not access non-published APIs except where documentation permits it or SAP otherwise authorizes it.
  • § 2.2.2 AI call sequences and data extraction. Outside SAP-endorsed architectures, data services or expressly identified pathways, the policy prohibits specified agentic API use and systematic or large-scale extraction.

MCP does not replace the API's documented-use boundary. Check that every endpoint is published for the intended use and whether the policy's AI-call or extraction provisions apply to the design.

SAP API Policy 4.2026a →

What it declares

Every artifact

Type
CLI
Origin
By SAP
Runtime
Node.js

As a CLI

Distributed through
npm

Parts and add-ons1

Parts 1

MCP servers1
SAP-samples/hana-cli-claude-pluginby SAPA Claude Code plugin that registers the MCP server of hana-cli, so Claude Code can work on SAP HANA Cloud and on-premise SAP HANA databases.

Connections4

Download
SAP-samples/hana-developer-cli-tool-example connectionsSAP-samples/hana-developer-cli-tool-examplePROVIDES→ provides3provides stated Bundles a Model Context Protocol server with the CLI so an AI assistant reaches the same HANA database through natural language, starting with about 22 focused tools and expanding on demand to the full command set. SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-exampleAgent access to your systemsprovides stated Runs administration work against a HANA database from a terminal: performance commands such as tableHotspots, queryPlan, alerts and healthCheck, a massGrant command that grants a privilege to a user, and backup and recovery operations. SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-example SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-example SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-exampleDatabase administrationprovides stated Reads a HANA table or view's catalog metadata and writes it as CDS, HDBTable or HDBMigrationTable, one object or in bulk, and manages the HDI containers and schema service instances a CAP project deploys native objects into. SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-example SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-example SAP-samples/hana-developer-cli-tool-example — README: https://github.com/SAP-samples/hana-developer-cli-tool-exampleNative SAP HANA artifactsLINEAGE← has part1has part derived Through: inverted from its part_of edgeSAP-samples/hana-cli-claude-plugin

Install

npm add SAP-samples/hana-developer-cli-tool-example

Derived from the package name. No recipe recorded; the README has the configuration.

README

quoted from SAP-samples/hana-developer-cli-tool-example under Apache-2.0, read
SAP-samples/hana-developer-cli-tool-example/README.mdOn GitHub

SAP HANA Developer Command Line Interface

REUSE status

⚠️ Important Notice - Major Updates (Feb/March 2026)

Version 4.x introduces significant changes including Express 5 migration, refactored database connection handling, and major performance improvements. While we've tested extensively, please be aware of potential issues in your specific environment.

If you encounter problems:

  • Report Issues: Please open an issue on our GitHub Issues page with details about your environment and the problem you're experiencing.

  • Rollback to Stable Version: If you need to quickly revert to the last stable release before these major changes, you can install version 3.202601.0 (January 2026):

    npm install -g hana-cli@3.202601.0

What's Changed: The change log describes all notable changes including Express 5 migration, database connection refactoring, CLI startup performance optimization (60-77% faster), expanded test coverage (85%+ coverage), and the new VitePress documentation site.

📚 Documentation

Complete documentation is available in the docs/ folder and organized with VitePress. This README will maintain a high-level overview and quick links to the most important sections of the documentation but over time expect that more and more detailed documentation will be added to the docs folder as the project evolves.

Quick Links:

Run Documentation Locally
cd docs
npm install
npm run docs:dev
# Open http://localhost:5173
Build For Production
cd docs
npm run docs:build
npm run docs:serve

See docs/README.md for complete documentation setup details.

Description

This sample is intended to shown how one could build a developer-centric SAP HANA command line tool, particularly designed to be used when performing local SAP HANA development in non-SAP tooling (like VSCode). It utilizes the default-env.json that is often used in local development for connectivity to a remote SAP HANA DB (although it can of course be used with a local SAP HANA, express edition instance as well). There is no intention to replacing the hdbsql tool as a generic SQL console. Instead this sample will focus on simplifying and grouping common and complex commands that otherwise might a lot of separate scripts.

Introduction Video: https://youtu.be/dvVQfi9Qgog

However the tool isn't limited to only local development. It also works well when developing in the cloud. The hana-cli tool can also run well from a cloud shell in the SAP Business Application Studio, Google Cloud Shell, AWS Cloud9, etc. We can also run against a SAP HANA service for SAP BTP or SAP HANA Cloud instance. This demonstrates that the tool can run just about anywhere you can get a command line that has access to the Node.js Runtime. We can also connect to a remote HANA instance even if it isn't running in the same cloud environment in which we are performing our development tasks.

Supported Environments
SAP HANA CLI Tool Development Environment Local Development Cloud Development VSCode Local SAP HANA Express Remote SAP HANA SAP Business App Studio Google Cloud Shell AWS Cloud9 SAP BTP HANA Service SAP HANA Cloud

Running in Cloud Shells Video: https://youtu.be/L7QyVLvAIIQ

Requirements / Download and Installation

If you would rather just access the tool directly, it is now available in npm as well. You can install via:

npm install -g hana-cli
Installation Methods
SAP HANA CLI Tool Installation Method NPM PackageQuick Install npm install -g hana-cli ✅ Ready to Use Clone & BuildFrom Source Clone Repositoryfrom GitHub Run npm install Run npm link ✅ Ready to Use

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

git clone https://github.com/SAP-samples/hana-developer-cli-tool-example
  • Run NPM install from the root of the hana-developer-cli-tool-example project you just cloned to download dependencies
npm install
npm link

asciicast

BTP CLI Installation

The hana-cli tool includes several commands that interact with SAP Business Technology Platform (BTP) services. All BTP-related functionality in this tool relies on the SAP BTP Command Line Interface (btp CLI) being installed and available in your system's PATH.

About the BTP CLI

The btp CLI is SAP's official command-line tool for managing resources and services on the SAP Business Technology Platform. It provides capabilities for managing global accounts, directories, subaccounts, entitlements, service instances, and more. The hana-cli tool wraps and extends many of these capabilities with developer-friendly commands.

Installing the BTP CLI with install-btp.sh

For Linux and macOS users, this repository includes a convenient installation script install-btp.sh that automates the installation of the BTP CLI.

The script performs the following actions:

  1. Downloads the latest BTP CLI installer from the SAP Development Tools download page
  2. Makes the installer executable and runs it with automatic confirmation
  3. Configures shell aliases for easier BTP CLI usage
  4. Adds the BTP CLI binary location to your PATH

To use the installation script:

chmod +x scripts/install-btp.sh
./scripts/install-btp.sh

After running the script, you may need to restart your terminal or run source ~/.bashrc to apply the PATH changes.

Note: Windows users should download the BTP CLI from the SAP Development Tools page and follow the platform-specific instructions there.

Verifying the Installation

Once installed, you can verify the BTP CLI is available by running:

btp --version

You can also use the hana-cli tool itself to check your BTP CLI configuration:

hana-cli btp

This will display your current BTP target information including global account, directory, and subaccount if configured.

Security

This application primarily uses the default-env.json that is often used in local development for connectivity to a remote HANA DB (although it can of course be used with a local SAP HANA, express edition instance as well). For more details on how the default-env.json works, see the readme.md of the @sap/xsenv package or the @sap/hdi-deploy package.

Connection Configuration Resolution Order

The tool doesn't simply look for a default-env.json file in the current directory however. There are numerous options and places it will look for the connection parameters. Here is the order in which it checks:

YES NO YES NO YES NO YES YES NO NO YES YES NO NO YES NO YES NO Connection ResolutionStarted Admin ModeEnabled? Look fordefault-env-admin.json .cdsrc-private.jsonFound? Found? Use Admin Credentials Use CAP cds bindDynamic Lookup .env FileFound? Secure Lookupfrom CF/K8s ContainsVCAP_SERVICES? Use VCAP Services E Look for specifiedconnection file Local orHome Found? Use Specified File F Found? Use default-env.json Last Resort:Look for default.jsonin HOME/.hana-cli/ Found? Use default.json ❌ No ConnectionConfiguration Found
  • First we look for the Admin option and use a default-env-admin.json - this overrides all other parameters
  • If no admin option or if there was an admin option but no default-env-admin.json could be found in this directory or 5 parent directories, then look for .cdsrc-private.json in this directory or 5 parent directories and use cds bind functionality to lookup the credentials securely. This is the most secure option, but please note: this will make each command take a few seconds longer as credentials are no longer stored locally but looked up from cf or k8s dynamically with each command
  • If no .cdsrc-private.json found in this directory or 5 parent directories, then look for a .env file in this directory or up to 5 parent directories
  • No .env file found or it doesn't contain a VCAP_SERVICES section, then check to see if the --conn parameter was specified. If so check for that file in the current directory or up to 5 parent directories
  • If the file specified via the --conn parameter wasn't found locally then check for it in the ${homedir}/.hana-cli/ folder
  • If no specific configuration file was was found then look for a file named default-env.json in the current directory or up to 5 parent directories
  • Last resort if nothing has been found up to this point - look for a file named default.json in the ${homedir}/.hana-cli/ folder

Examples

A lot of the functionality of this tool revolves around typical tasks you face while doing HANA database development. For example you might want to get a list of all views in your current schema/container:

C:\github\hana-xsa-opensap-hana7\user_db>hana-cli views
Schema: OPENSAP_HANA_USER, View: *
SCHEMA_NAME        VIEW_NAME                                    VIEW_OID  COMMENTS
-----------------  -------------------------------------------  --------  ------------
OPENSAP_HANA_USER  user.models::USER_DETAILS                    171133    USER_DETAILS
OPENSAP_HANA_USER  user.models::USER_DETAILS/hier/USER_DETAILS  171139    null

Then perhaps you want to inspect a view to see the columns and their data types:

C:\github\hana-xsa-opensap-hana7\user_db>hana-cli view * user.models::USER_DETAILS
Schema: %, View: user.models::USER_DETAILS
{ SCHEMA_NAME: 'OPENSAP_HANA_USER',
  VIEW_NAME: 'user.models::USER_DETAILS',
  VIEW_OID: 171133,
  COMMENTS: 'USER_DETAILS',
  IS_COLUMN_VIEW: 'TRUE',
  VIEW_TYPE: 'CALC',
  HAS_STRUCTURED_PRIVILEGE_CHECK: 'TRUE',
  HAS_PARAMETERS: 'TRUE',
  HAS_CACHE: 'NONE',
  CREATE_TIME: '2019-07-30 13:14:15.594000000' }


SCHEMA_NAME        VIEW_NAME                  VIEW_OID  COLUMN_NAME  POSITION  DATA_TYPE_NAME  OFFSET  LENGTH  SCALE  IS_NULLABLE  DEFAULT_VALUE  CS_DATA_TYPE_NAME  COLUMN_ID  COMMENTS
-----------------  -------------------------  --------  -----------  --------  --------------  ------  ------  -----  -----------  -------------  -----------------  ---------  ---------
OPENSAP_HANA_USER  user.models::USER_DETAILS  171133    EMAIL        1         NVARCHAR        0       255     null   TRUE         null           STRING             171135     Email
OPENSAP_HANA_USER  user.models::USER_DETAILS  171133    FIRSTNAME    2         NVARCHAR        0       40      null   TRUE         null           STRING             171136     FirstName
OPENSAP_HANA_USER  user.models::USER_DETAILS  171133    LASTNAME     3         NVARCHAR        0       40      null   TRUE         null           STRING             171137     LastName
OPENSAP_HANA_USER  user.models::USER_DETAILS  171133    USERID       4         INTEGER         0       10      0      TRUE         null           INT                171138     UserId

But there are multiple output options for inspection. Perhaps you are using Cloud Application Programming Model and need to create a proxy entity in CDS for a view. This tool will read the catalog metadata and convert it to CDS:

C:\github\hana-xsa-opensap-hana7\user_db>hana-cli view OPENSAP_HANA_USER user.models::USER_DETAILS -o cds
Schema: OPENSAP_HANA_USER, View: user.models::USER_DETAILS
@cds.persistence.exists
Entity user_modelsUSER_DETAILS {
 key    "EMAIL": String(255) null  @title: 'EMAIL: Email' ;
key     "FIRSTNAME": String(40) null  @title: 'FIRSTNAME: FirstName' ;
key     "LASTNAME": String(40) null  @title: 'LASTNAME: LastName' ;
key     "USERID": Integer null  @title: 'USERID: UserId' ;
}

Or maybe you are service enabling this view and you want to see it converted to EDMX:

C:\github\hana-xsa-opensap-hana7\user_db>hana-cli view OPENSAP_HANA_USER user.models::USER_DETAILS -o edmx
Schema: OPENSAP_HANA_USER, View: user.models::USER_DETAILS
<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="1.0" xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:sap="http://www.sap.com/Protocols/SAPData">
  <edmx:Reference Uri="https://wiki.scn.sap.com/wiki/download/attachments/448470974/Common.xml?api=v2" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
    <edmx:Include Alias="Common" Namespace="com.sap.vocabularies.Common.v1"/>
  </edmx:Reference>
  <edmx:DataServices m:DataServiceVersion="2.0">
    <Schema Namespace="HanaCli" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
      <EntityContainer Name="EntityContainer" m:IsDefaultEntityContainer="true">
        <EntitySet Name="user_modelsUSER_DETAILS" EntityType="HanaCli.user_modelsUSER_DETAILS"/>
      </EntityContainer>
      <EntityType Name="user_modelsUSER_DETAILS">
        <Key>
          <PropertyRef Name="EMAIL"/>
          <PropertyRef Name="FIRSTNAME"/>
          <PropertyRef Name="LASTNAME"/>
          <PropertyRef Name="USERID"/>
        </Key>
        <Property Name="EMAIL" Type="Edm.String" MaxLength="255"/>
        <Property Name="FIRSTNAME" Type="Edm.String" MaxLength="40"/>
        <Property Name="LASTNAME" Type="Edm.String" MaxLength="40"/>
        <Property Name="USERID" Type="Edm.Int32"/>
      </EntityType>
      <Annotations Target="HanaCli.user_modelsUSER_DETAILS/EMAIL" xmlns="http://docs.oasis-open.org/odata/ns/edm">
        <Annotation Term="Common.Label" String="EMAIL: Email"/>
      </Annotations>
      <Annotations Target="HanaCli.user_modelsUSER_DETAILS/FIRSTNAME" xmlns="http://docs.oasis-open.org/odata/ns/edm">
        <Annotation Term="Common.Label" String="FIRSTNAME: FirstName"/>
      </Annotations>
      <Annotations Target="HanaCli.user_modelsUSER_DETAILS/LASTNAME" xmlns="http://docs.oasis-open.org/odata/ns/edm">
        <Annotation Term="Common.Label" String="LASTNAME: LastName"/>
      </Annotations>
      <Annotations Target="HanaCli.user_modelsUSER_DETAILS/USERID" xmlns="http://docs.oasis-open.org/odata/ns/edm">
        <Annotation Term="Common.Label" String="USERID: UserId"/>
      </Annotations>
    </Schema>
  </edmx:DataServices>
</edmx:Edmx>

This tool will even create a temporary OData V4 service for any existing table, view or Calculation View and launch a test Fiori Ui locally. Fioir Example

Project Structure and Documentation

Utils Documentation

For developers looking to understand or extend the internal utilities used by this CLI tool, comprehensive documentation is available in the utils/README.md file. This documentation covers:

  • Core Utilities: base module, connection management, database inspection, SQL injection protection
  • CLI Integration: BTP, Cloud Foundry, and XSA CLI integration utilities
  • Database Abstraction: Multi-database support (HANA, PostgreSQL, SQLite) with factory pattern
  • Usage Examples: Practical examples for using the utility modules

The utils folder contains reusable modules that provide the foundation for all CLI commands, including database connectivity, terminal UI components, security utilities, and internationalization support.

HTTP Routes Documentation

The hana-cli tool includes a built-in web server that exposes all CLI functionality through RESTful HTTP endpoints. Detailed documentation for all HTTP routes is available in the routes/README.md file. This documentation covers:

  • Base Configuration Endpoints: GET/PUT operations for managing CLI prompts and settings
  • HANA Database Endpoints: Complete API for listing and inspecting HANA database objects (tables, views, schemas, containers, etc.)
  • Documentation Endpoints: Access to README and CHANGELOG as HTML
  • WebSocket Support: Real-time communication for long-running operations
  • Static Resources: UI5 application and DFA integration

The web server is automatically started when using certain CLI commands with the -w or --web flag, making all hana-cli functionality accessible via HTTP requests at http://localhost:3010 (configurable port).

Swagger/OpenAPI Documentation

The hana-cli web server now includes comprehensive Swagger/OpenAPI 3.0 documentation for all REST API endpoints. This provides an interactive interface for exploring and testing all HTTP APIs, making it easier to integrate hana-cli functionality into your own applications.

Key Features:

  • Interactive API Documentation: Browse all 27+ documented endpoints with full request/response schemas
  • Try-It-Out Functionality: Test any API endpoint directly from the browser
  • Auto-Generated Specification: Documentation automatically generated from JSDoc comments in route files
  • OpenAPI 3.0 Standard: Industry-standard specification for maximum compatibility
  • Organized Categories: Endpoints grouped into 10 logical categories (Configuration, HANA System, HANA Objects, HDI, Cloud Services, etc.)
  • Export Support: Download the raw OpenAPI JSON specification for client SDK generation

Accessing Swagger UI:

# Start the UI server
hana-cli ui

# Open browser to Swagger UI
http://localhost:3010/api-docs

# Get raw OpenAPI JSON specification
http://localhost:3010/api-docs.json

For complete implementation details, usage examples, and customization options, see the SWAGGER_IMPLEMENTATION.md documentation.

Web Applications (Fiori Launchpad UI)

The hana-cli tool includes a complete browser-based interface built with SAP UI5 and the Fiori Launchpad, providing a graphical alternative to the command-line interface. This web interface offers an intuitive, tile-based navigation system for all database operations.

--web flag hana-cliCommand LineInterface Web ServerPort 3010 Fiori Launchpad UISAP UI5 Application DatabaseOperations Cloud ServicesBTP/CF Integration AdminFunctions Tables,Views,Schemas Indexes,Functions,Procedures HDIContainers SBSSServices SecureStore& Schema MassConversion SystemMonitoring REST API Swagger/OpenAPIDocumentation27+ Endpoints

Key Features:

  • Fiori Launchpad Interface: Modern, responsive UI with organized tile groups
  • Multiple UI5 Applications: Specialized apps for listing, inspecting, and managing database objects
  • Real-Time Operations: WebSocket-based communication for live updates and long-running tasks
  • Mass Conversion Tool: Bulk convert tables to CDS, HDBTable, or HDBMigrationTable formats
  • System Information Dashboard: View connection details, version info, and system status
  • Database Object Browser: Interactive exploration of tables, views, schemas, functions, indexes, and more
  • Cloud Foundry Integration: Manage HDI, SBSS, Schema, and SecureStore service instances
  • Theme Support: Automatic light/dark mode detection and customization
  • Integrated Help: SAP Digital Foundation Adapter (DFA) with contextual assistance

Quick Start:

hana-cli tables -w    # Launch web interface with tables view
hana-cli serve        # Start the web server standalone

The web UI runs on http://localhost:3010 by default and provides access to all CLI functionality through an easy-to-use graphical interface. For complete documentation of all web applications, UI5 components, configuration, and development guides, see the app/README.md file.

MCP (Model Context Protocol) Integration

The hana-cli tool includes a Model Context Protocol (MCP) server, enabling AI assistants like Claude to interact with SAP HANA databases through natural language. The server uses a progressive discovery model — starting with ~22 focused tools and expanding on demand to all 186 commands.

Natural LanguageQuery Router orDirect Call Data & Results Service Info Container Status FormattedResponse Natural LanguageResult 🤖 AI AssistantClaude, etc. MCP Server~22 Default Tools 186 hana-cliCommands SAP HANADatabase BTP/CloudServices HDIContainers

Key Features:

  • Progressive tool discovery — tier-1 tools always available, others via router or dynamic promotion
  • Router tool (hana_execute) dispatches any of 183+ commands by name
  • AI-guided command recommendations and smart search
  • Seamless integration with Claude Desktop, VS Code, Cursor, and other MCP clients
  • --full mode available for environments where tool count is not a concern

For detailed setup instructions, configuration options, and usage examples, please refer to:

Standard Parameters and Conventions

The hana-cli tool follows consistent parameter naming, aliasing, and default value conventions across all commands to provide a predictable and intuitive user experience.

Command Categories Overview
200+ hana-cliCommands CommandCategory ConnectionCommands DataManipulation DatabaseInspection PerformanceAnalysis CloudIntegration HDIManagement connectcopy2DefaultEnvcopy2Env exportimportdataSynctableCopy tablesviewsproceduresschemasindexes tableHotspotsqueryPlanalertshealthCheck btpbtpInfoactivateHDI containerscreateContainerdropContainer
Global Standard Parameters

All commands support the following standard connection and debugging parameters:

ParameterAliasTypeDefaultDescription
--admin-abooleanfalseConnect via admin credentials (uses default-env-admin.json)
--conn—string—Connection filename to override default-env.json
--disableVerbose--quietbooleanfalseDisable verbose output for scripting
--debug-dbooleanfalseEnable debug output for troubleshooting
Common Command Parameters

Commands are organized into categories, each with their own standardized parameters:

Data Manipulation Commands

Commands like export, import, compareData, tableCopy, dataSync, etc.

ParameterAliasTypeDefaultDescription
--schema-sstring**CURRENT_SCHEMA**Target schema name
--sourceSchema-ssstring**CURRENT_SCHEMA**Source schema for operations
--targetSchema-tsstring**CURRENT_SCHEMA**Target schema for operations
--table / --sourceTable-t / -ststring—Table name(s)
--output-ostring—Output file path
--format-fstringsee noteOutput format (csv, json, excel, summary, etc.)
--limit-lnumber1000Maximum result set size
--batchSize-b, --batchnumber1000Batch size for processing
--timeout-tonumber3600Operation timeout in seconds (1 hour)
--dryRun-dr, --previewbooleanfalsePreview operation without committing changes
--profile-pstring—Database profile (hana, postgresql, sqlite, etc.)
Batch Operations

Commands like massGrant, massUpdate, massDelete, massExport, etc.

ParameterAliasTypeDefaultDescription
--schema-sstring—Schema containing objects
--object-ostring—Object name pattern
--limit-lnumber1000Maximum objects to process
--dryRun-dr, --previewbooleanfalsePreview without executing
--log—booleanfalseEnable operation logging
List/Inspect Commands

Commands like tables, schemas, users, procedures, functions, etc.

ParameterAliasTypeDefaultDescription
--schema-sstring**CURRENT_SCHEMA**Filter by schema
--limit-lnumber200Maximum results to return
--profile-pstring—Database profile selector
Naming Conventions

The tool follows these conventions for parameter naming:

  1. Single Operations: Use singular names (e.g., schema, table, user)
  2. Source/Target Operations: Use paired names (e.g., sourceSchema/targetSchema, sourceTable/targetTable)
  3. Boolean Flags: Use descriptive names (e.g., dryRun, includeHeaders, withGrantOption)
  4. Aggregation Parameters: Use plural or descriptive names (e.g., columns, indexes, keyColumns)
Alias Conventions

Aliases follow these consistent patterns:

  1. Single-letter alias: First letter of the parameter (e.g., -s for schema, -t for table)
  2. Extended alias: Meaningful abbreviation (e.g., -dr for dryRun, -batch for batchSize)
  3. No self-referential aliases: Parameter name itself is not used as an alias (e.g., --schema has alias -s only)
  4. Maximum aliases: Parameters typically have at most 2 aliases to avoid confusion
Default Values

Default values are standardized to ensure consistent behavior:

ParameterStandard DefaultNote
schema**CURRENT_SCHEMA**Uses the connection's current schema
limit200 (lists) / 1000 (data)Configurable per command based on context
batchSize1000Applies to all data manipulation operations
timeout36001 hour standard timeout for long-running operations
dryRunfalseChanges are committed by default; use --dryRun to preview
format"csv" (export) / "json" (reports)Varies by command type
compresstrueData backups are compressed by default
Usage Examples
Using Standard Parameters
hana-cliCommand ChooseOperation List Operationtables, views, etc. --schema-s --limit-l --profile-p Filter by schema Limit results Select DB profile Data Operationexport, import, etc. --sourceTable/-st--targetTable/-tt --format-f --dryRun/-dr--preview Source/Target Output format Dry run preview Batch OperationmassGrant, etc. --schema/-s --dryRun/-dr --log Target schema Safe execution Operation log 
# List all tables in current schema with preview of first 100
hana-cli tables -s myschema -l 100

# Export data with dry-run preview
hana-cli export -t CUSTOMERS -s SALES -f csv -dr

# Copy table structure without data (dry-run)
hana-cli tableCopy --sourceTable ORDERS --targetTable ORDERS_ARCHIVE --structureOnly --dryRun

# Compare schemas between databases with 2-hour timeout
hana-cli compareSchema --sourceSchema PROD --targetSchema TEST -to 7200

# Batch grant permissions (preview first)
hana-cli massGrant -s MYSCHEMA -o MYTABLE -g DEVELOPER_USER -p SELECT -dr
Common Parameter Combinations
# Preview and log operations
hana-cli massUpdate -s SCHEMA -o TABLE -c "STATUS='ACTIVE'" --dryRun --log

# Limit results and increase timeout for large datasets
hana-cli dataValidator -t BIGDATA -l 1000000 -to 7200

# Specify output format and location
hana-cli export -t CUSTOMERS -f json -o ./exports/customers.json
Current Schema Defaults (**CURRENT_SCHEMA**)

The vast majority of schema-aware commands now use **CURRENT_SCHEMA** as the default value for schema parameters. This special placeholder allows you to work with your current database context without explicitly specifying the schema name each time.

Supported Commands with Current Schema Default

The following command categories fully support the **CURRENT_SCHEMA** placeholder:

Listing Commands (30+ commands):

  • All schema navigation: tables, views, indexes, functions, procedures, triggers, sequences, synonyms, libraries, roles, objects
  • Specialized lists: partitions, columnStats, spatialData, ftIndexes, graphWorkspaces, tableHotspots, tableGroups, calcViewAnalyzer

Data Manipulation Commands (10+ commands):

  • export, import, dataProfile, dataDiff, compareData, compareSchema, tableCopy, dataSync

Analysis Commands (10+ commands):

  • dataValidator, duplicateDetection, erdDiagram, dataLineage, referentialCheck, and more
Current Schema Examples
# Without explicit schema - uses CURRENT_SCHEMA
hana-cli tables                          # List tables in current schema
hana-cli procedures                      # List procedures in current schema
hana-cli export -t CUSTOMERS             # Export from current schema

# With explicit schema override
hana-cli tables -s PRODUCTION            # List tables in PRODUCTION schema
hana-cli procedures -s OTHER_SCHEMA      # List procedures in OTHER_SCHEMA
hana-cli export -t CUSTOMERS -s SALES    # Export from SALES schema

For a complete list of all commands with **CURRENT_SCHEMA** support, see the CONSISTENCY_REVIEW_COMPLETE.md document.

Multi-Profile Database Support

All database-connected commands now support the --profile parameter (alias -p), enabling you to work with different database configurations without switching connections or redefining credentials.

Supported Commands with Profile Parameter

The --profile parameter is available in:

  • All data operations: export, import, dataProfile, dataDiff, dataSync, duplicateDetection, referentialCheck, tableCopy
  • List operations: tables, views, indexes, functions, procedures, triggers, sequences, libraries, roles, objects, partitions, columnStats, spatialData, ftIndexes, graphWorkspaces, tableHotspots, tableGroups, calcViewAnalyzer
  • Analysis tools: compareData, compareSchema, dataValidator, dataLineage, erdDiagram, and more
Profile Parameter Examples
# Specify database profile
hana-cli tables --profile production     # Connect using 'production' profile
hana-cli export -t CUSTOMERS -p staging  # Export from staging environment
hana-cli dataValidator -t TABLE -p dev   # Validate data in development

# Works with other parameters
hana-cli tables -s MYSCHEMA -p prod      # List tables in schema using prod profile
hana-cli compareSchema -ss SRC -ts TGT -p target  # Schema comparison using target profile

For more details on database profile configuration, see the utils/README.md documentation.

Quality Assurance Notes

The consistency of these parameters has been standardized across all 200+ commands in the tool. This standardization ensures:

  • Predictability: Users can rely on consistent parameter behavior across commands
  • Discoverability: Common parameters work the same way in different contexts
  • Scripting: Automation scripts are more maintainable with consistent patterns
  • Error Reduction: Familiar patterns reduce mistakes and learning curve
  • Multi-Environment Support: Profile parameter enables seamless switching between database instances

For detailed analysis of all command consistency improvements deployed in February 2026, including the 30 commands and 50+ parameters updated, see:

For detailed information about specific commands, use the built-in help:

hana-cli help <command>
hana-cli <command> --help

Commands

📊 Visual Command Reference Guide: For command structure diagrams, parameter relationships, and quick examples for all commands, see the Command Structure Reference Guide. This separate document provides visual flowcharts and detailed usage patterns for:

  • Connection & setup commands
  • Data operations (export, import, sync)
  • Database inspection & analysis
  • HDI container management
  • Backup & recovery operations
  • Performance analysis tools
  • Mass operations
  • Cloud integration

Each command diagram shows the command syntax, available parameters, and typical usage patterns.

Unit Testing

This project includes comprehensive unit tests to ensure code quality and reliability. The test suite covers core functionality, command execution, and database operations.

For detailed information about running tests, writing new tests, and understanding the test structure, please refer to the Unit Testing Documentation.

Running Tests

Quick start for running tests:

# Run all tests
npm test

# Run specific test suites
npm run test:cli      # CLI tests only
npm run test:utils    # Utils tests only
npm run test:routes   # Routes tests only
Code Coverage

The project uses nyc (Istanbul) for code coverage reporting. To generate code coverage reports:

# Run all tests with coverage
npm run coverage

# Run specific test suites with coverage
npm run coverage:cli      # CLI tests with coverage
npm run coverage:utils    # Utils tests with coverage
npm run coverage:routes   # Routes tests with coverage

# Generate detailed HTML coverage report
npm run coverage:report

# Check if coverage meets thresholds (80%)
npm run coverage:check

After running coverage tests, open ./coverage/index.html in your browser to view the detailed interactive coverage report.

The project aims for 80% code coverage across:

  • Lines
  • Statements
  • Functions
  • Branches

For more information about code coverage configuration and interpretation, see the Coverage section in the Unit Testing Documentation.

Cross-Platform Support

The HANA CLI tool is designed to work seamlessly across Windows, Linux, and macOS platforms. This section describes the cross-platform features and testing strategies employed to ensure consistent behavior.

Platform Compatibility

The tool has been tested and validated on:

  • Windows: Windows 10 and later
  • Linux: Ubuntu, Debian, RHEL, and other major distributions
  • macOS: macOS 10.15 (Catalina) and later
Cross-Platform Features
Path Handling

The tool automatically handles platform-specific path differences:

  • Uses Node.js path module for all path operations
  • Automatically detects and uses correct path separators (/ on Unix, \ on Windows)
  • Normalizes paths for consistent behavior across platforms
  • Supports both absolute and relative paths on all platforms
Environment Variables

Platform-specific environment variables are handled correctly:

  • Windows: Uses APPDATA for configuration files
  • macOS: Uses HOME/Library/Preferences with fallback to HOME/Library/Application Support
  • Linux: Uses HOME/.config for configuration files
Line Endings

The project uses .gitattributes to ensure consistent line endings:

  • Text files (.js, .json, .md, etc.) use LF (\n) in the repository
  • Windows scripts (.cmd, .bat, .ps1) use CRLF (\r\n)
  • Binary files are handled appropriately
Cross-Platform Testing

The project includes comprehensive cross-platform testing:

# Run cross-platform specific tests
npm run test:platform

# Run tests tagged for Windows
npm run test:windows

# Run tests tagged for Unix systems (Linux/macOS)
npm run test:unix
Continuous Integration

GitHub Actions CI runs the full test suite on all three platforms:

  • Ubuntu Latest: Tests Linux compatibility
  • Windows Latest: Tests Windows compatibility
  • macOS Latest: Tests macOS compatibility
  • Node.js versions: 20.x, 22.x, and 24.x on each platform

The CI workflow validates:

  • Package installation on each platform
  • All unit tests pass on each platform
  • Cross-platform specific tests
  • Platform-specific path handling
  • CLI command execution
Mock Filesystem Testing

Tests use mock-fs to simulate different filesystem structures:

  • Tests can simulate Windows, macOS, and Linux filesystems
  • Validates path handling without requiring multiple OS environments
  • Tests platform-specific configuration file locations
  • Ensures consistent behavior across platforms
Development Recommendations

When contributing to this project, follow these cross-platform best practices:

  1. Always use path.join() or path.resolve() instead of string concatenation for paths
  2. Use os.EOL for platform-appropriate line endings in generated content
  3. Test environment variable fallbacks for Windows (APPDATA, USERPROFILE) and Unix (HOME)
  4. Tag platform-specific tests with @windows or @unix as appropriate
  5. Use cross-env in npm scripts for environment variable consistency
  6. Avoid hard-coded path separators (/ or \) in code

For more details on cross-platform testing, see the Cross-Platform Testing section in the Unit Testing Documentation.

How to obtain support

This project is provided "as-is": there is no guarantee that raised issues will be answered or addressed in future releases.

License

Copyright (c) 2026 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.

Apache-2.0, read

History

Latest

v4.202609.0

Other 3

Notes

Fixed

  • hana-cli-mcp binary failed to start because @modelcontextprotocol/sdk was only declared in the nested mcp-server package (stripped from the published tarball); it is now a root dependency (#231)
  • Patched dependency vulnerabilities via npm audit fix plus qs and brace-expansion overrides (#233)

Changed

  • Migrated WebdriverIO UI tests off the deprecated devtools automation service to standard WebDriver/BiDi; dropped devtools and @wdio/devtools-service dev dependencies (#234)

  1. v4.202607.1

    Other 5

    Notes

    Fixed

    • VS Code extension: resolve HANA connection when the CAP project (with .cdsrc-private.json / default-env.json) lives in a subfolder rather than the workspace root; scans subfolders and prompts when multiple projects are found (#182)
    • VS Code extension: artifact inspectors (hdbtable, hdbview, hdbfunction, hdbprocedure, hdbsynonym, hdbrole, hdbsequence) now pre-fill the object name from the opened file
    • VS Code extension: type-ahead suggestions now work in webview inputs (schema/table/etc.) by using the local server base URL instead of relative fetch paths

    Added

    • VS Code extension: hana-cli.projectPath setting to explicitly point at the connection-config folder and skip auto-detection (#182)

    Changed

    • hana-cli vscode status now compares the installed extension against the packaged .vsix and suggests updating; vscode install upgrades in place via --force (#182)

  2. v4.202607.0

    Other 5

    Notes

    Added

    • VS Code extension now ships a self-contained, OS-portable .vsix via the npm package (installable through hana-cli vscode install) — bundles the web UI and uses Node built-in node:sqlite, no native binaries (#159)

    Changed

    • Upgrade to CAP 10 (@sap/cds 10) with cds-10-native drivers @cap-js/hana 3, @cap-js/sqlite 3, @cap-js/postgres 3, @cap-js/telemetry 2; remove incompatible @sap/cds-hana (#160)
    • TypeScript 7 for the VS Code extension and MCP server; consolidated dependency updates across all subprojects (#160, #162)
    • Group B major dependency upgrades: glob 13, @vscode/test-electron 3, vue-tsc 3, vue-router 5, csv-parse 7, js-yaml 5, inquirer 14 (#162)

    Fixed

    • Add missing vscode + error.cfNotLoggedIn i18n keys across all 9 locales (#163)

  3. v4.202605.2

    Other 10

    Notes

    Added

    • MCP server tiered tool architecture: tier-1 essential tools are always available, category-specific tools activate on demand via hana_discover_by_category
    • New hana_execute router tool for generic command dispatch without per-command tool registration
    • JSON test reporter (npm run test:json) for structured result querying with jq

    Fixed

    • MCP server: preserve empty cell values in ASCII table parser
    • MCP server: deduplicate tier-1 tools on category activation
    • querySimple now exits 0 for DML/DDL statements
    • Security: update uuid to 11.1.1 in docs to resolve vulnerability alert

    Changed

    • MCP server: extract shared utilities into reusable modules and add mocked querySimple tests
    • MCP server: add dynamic registration callback to discovery-tools for on-demand tool loading
    • Dependency updates to latest patch/minor versions

  4. v4.202605.1

    Other 1

    Notes

    Changed

    • Release version 4.202605.1

  5. v4.202605.0

    Other 18

    Notes

    Fixed

    • MCP server connection context: wired up dead connFile code so HANA_CLI_CONN_FILE env var is now honored when resolving connection files
    • MCP server default working directory: executor now prefers the launch directory over the hana-cli install directory when project markers (package.json, default-env.json, .env, .cdsrc-private.json) are detected

    Changed

    • Minimum Node.js version raised from 20.19.0 to 22.0.0 (preparing for CDS 10)
    • Added CDS 10 forward-compatibility flags: ieee754compatible, compat_srv_getters, compat_texts_entities, calc_elements
    • Added queue.legacyLocking: false for CDS 10 outbox locking behavior
    • Updated peerDependencies to accept @sap/cds-dk >=10.0.0
    • Updated CI matrix to Node.js 22.x and 24.x (dropped 20.x)
    • Updated @cap-js/hana from ^2.7.1 to ^2.8.0
    • Updated @cap-js/postgres from ^2.2.1 to ^2.3.0
    • Updated @cap-js/sqlite from ^2.2.1 to ^2.4.0
    • Updated @sap/cds-common-content from ^3.1.0 to ^3.2.0
    • Updated chromedriver from ^147.0.4 to ^148.0.1
    • Updated eslint from ^10.2.1 to ^10.3.0
    • Updated @wdio/* packages from ^9.27.0 to ^9.27.1
    • Updated webdriverio from ^9.27.0 to ^9.27.1
    • Upgraded TypeScript from 5.x to 6.x across project (MCP server ^6.0.2, root devDependencies)
    • Updated tsconfig.json files for TypeScript 6 compatibility: moduleResolution Node→Bundler (root), Node16→NodeNext (MCP server)
    • Updated @types/node from ^25.5.0 to ^25.6.0

  6. v4.202604.0

    Other 1

    Notes

    Added

    • New mcpServerInstall command (hana-cli mcp) for one-command MCP server configuration in Claude Desktop, Claude Code, Cursor, Windsurf, Cline, VS Code, Continue, and Zed
    • New mcpServerStatus command (hana-cli mcp-status) to check MCP server installation status across all 8 supported AI assistant clients
    • MCP resources for knowledge base content and documentation index metadata

    Changed

    • Major MCP server refactor: modular architecture replacing monolithic 1,700-line index.ts
    • Reduced MCP tool count by removing alias registrations and consolidating search tools
    • Updated MCP SDK from 1.27.1 to 1.29.0
    • Fixed MCP server version to read dynamically from package.json
    • Fixed fragile command name matching in output formatter
    • Added isError signaling to all MCP error response paths

    Removed

    • Removed simulated workflow execution tools (LLMs orchestrate multi-step tasks more effectively)
    • Removed no-op validateEnvironment function and low-value metadata tools

  7. v4.202604.0

    Other 11

    Notes

    Added

    • New mcpServerInstall command (hana-cli mcp) for one-command MCP server configuration in Claude Desktop, Claude Code, Cursor, Windsurf, Cline, VS Code, Continue, and Zed
    • New mcpServerStatus command (hana-cli mcp-status) to check MCP server installation status across all 8 supported AI assistant clients
    • MCP resources for knowledge base content and documentation index metadata

    Changed

    • Major MCP server refactor: modular architecture replacing monolithic 1,700-line index.ts
    • Reduced MCP tool count by removing alias registrations and consolidating search tools
    • Updated MCP SDK from 1.27.1 to 1.29.0
    • Fixed MCP server version to read dynamically from package.json
    • Fixed fragile command name matching in output formatter
    • Added isError signaling to all MCP error response paths

    Removed

    • Removed simulated workflow execution tools (LLMs orchestrate multi-step tasks more effectively)
    • Removed no-op validateEnvironment function and low-value metadata tools

  8. v4.202603.2

    Other 4

    Notes

    Fixed

    • Fix for CDS 9.8x compatibility - corrected CDS binding and path resolution when hana-cli commands are invoked from a project sub-directory, ensuring proper project root detection and CDS model loading regardless of working directory

    Changed

    • Update MCP SDK version in mcp-server package for improved compatibility and stability
    • MCP Server Infrastructure Cleanup - refactored command-metadata, resources, readme-knowledge-base, and examples-presets modules for cleaner architecture and better maintainability
    • Improve WDI5 end-to-end test infrastructure and update shrinkwrap dependencies for UI testing

  9. v4.202603.1

    Other 8

    Notes

    Changed

    • Patch release to align all package and release metadata to version 4.202603.1
    • Bump MCP server package version to 1.202603.1
    • Update changelog and lockfile metadata for March 2026 patch release
    • Add new documentation URL in package.json
    • Clean shrinkwrap file to remove old version references and ensure consistency with new version
    • Blog Posts added to Documentation site
    • Fixed issue with three commands not having the correct documentation link
    • Fix issue Mass Export is giving Invalid Column Name: COLUMN_POSITION for each table exported

  10. v4.202603.0

    Other 11

    Notes

    Changed

    • Update SAPUI5 version to 1.145.0
    • Maintenance version update for March 2026
    • Various dependency updates and security patches
    • Improved stability and performance optimizations
    • Expanded localization support with full translation bundles for Simplified Chinese (zh), Hindi (hi), and Polish (pl) across CLI and feature property files
    • Updated i18n validation and documentation to include the current supported language set and locale examples
    • Enhanced CLI UX with suggestions for unknown commands and unsupported options to help users recover quickly from typos
    • Added configuration management workflow to load and apply saved command settings across supported CLI operations
    • Improved analysis and comparison tooling with better current-schema handling and stronger error handling in compareSchema and duplicateDetection/dataValidator workflows
    • Enhanced UI command server configuration with prompt-driven host and port options for more flexible local startup
    • Improved CDS binding resolution and connection error handling by loading @sap/cds-dk from global node modules when needed

  11. v4.202602.0

    Other 15

    Notes

    Changed

    • Major version bump to 4.x reflecting significant internal improvements and enhanced stability
    • Update SAPUI5 version and dependencies to 1.144.1
    • Various dependency updates and maintenance - especially update to @sap/cds-dk 9.7.1 for better compatibility with cds-fiori plugin and the latest CAP features
    • Migrate from Express 4.x to 5.x now that CAP supports Express 5 as well. This is a major internal change but should be mostly transparent to users. If you do see any issues please report them.
    • Convert from node-zip to JSZip for better support and maintenance going forward
    • Low level refactoring of DB connection handling to better support MCP server and future features. This should be mostly transparent to users but if you see any issues please report them.
    • Using AI Code Generation - massive expansion of test cases and test coverage - 317+ new tests added across 6 new test files, improving coverage from ~40% to ~85% of critical paths
    • Enhanced README files throughout the project with better documentation and more examples
    • First version of German Localization - added German translations for key commands (inspect, massConvert, messages, systemInfo, tables)
    • MCP (Model Context Protocol) Server enhancements - added comprehensive troubleshooting documentation and improved error handling for better AI assistant integration
    • New MCP server troubleshooting guide (mcp-server/TROUBLESHOOTING.md) with common issues and solutions
    • Improved error messages and debugging capabilities throughout the codebase
    • CLI Startup Performance Optimization - Implemented lazy-loading strategy for command modules and dependencies, resulting in 60-77% faster startup times for most commands. Key improvements: ultra-fast path for --version flag bypassing all heavy module imports, deferred yargs loading until after fast-path checks, conditional debug module loading only when DEBUG environment variable is set, elimination of completion overhead, and simplified validation logic. Average command execution now starts in ~700ms vs previous ~2,200ms.
    • New import command features - added support for matching columns by order, name, or auto (try name then fall back to order), improved error handling and reporting for mismatched columns and data type issues, and added support for additional data types in the import process
    • Completely new documentation website build on VitePress with improved navigation, search, and user experience. The new documentation site is built with VitePress and features a modern design, better organization, and enhanced content including more examples and troubleshooting guides. The documentation is now also available in German for key sections.

  12. v3.202601.0

    Other 6

    Notes

    Changed

    • Update SAPUI5 version and dependencies to 1.144.0
    • Update license year, version, and Node.js requirement
    • Update Node.js version to 24 and copyright year
    • Various dependency updates and maintenance
    • Removed Fiori Preview page from cds command and replaced it with calls to @sap/cds-fiori plugin for better future compatibility
    • Experimental: First, very rough, version of an MCP server that exposes all hana-cli commands

  13. v3.202511.0

    Other 5

    Notes

    Changed

    • Update yargs to v18 and improve type definitions
    • Update SAPUI5 version and dependencies to 1.142.0
    • Update license year, version, and Node.js requirement
    • Update Node.js version to 22 and copyright year
    • Various dependency updates and maintenance

  14. v3.202504.1

    Other 2

    Notes

    Changed

    • CAP Version 8.9.0
    • Emergency Fix for CAP version 8.9 - changes to how binding works. This version of hana-cli only works with @sap/cds-dk 8.9 and higher. If you are using older version of @sap/cds-dk then you must also use older versions of the hana-cli.

  15. v3.202405.1

    Other 4

    Notes

    Changed

    • CAP Version 7.9.0
    • SAPUI5 to version 124.0
    • Added @cap-js/telemetry that is activated when the command is in debug
    • Switch to @cap-js/hana for the CAP HANA DB implementation

  16. v3.202403.3

    Other 5

    Notes

    Changed

    • Update btpSubs and bas commands to support SAP Build Code. Will launch Build Code Lobby when subscribed.
    • Beta Support for HANA Vector data type in CDS
    • General Support for HANA Vector Engine at the DB/SQL level
    • CAP Version 7.8.0
    • SAPUI5 to version 122.0

  17. v3.202403.1

    Other 2

    Notes

    Changed

  18. v3.202402.2

    Other 2

    Notes

    Changed

    • Mass Convert of Tables to CDS if you use Pure Catalog Definitions, it will output sql append content
    • Table inspect to CDS if you choose no Persistence Exists, it will output sql append content

  19. v3.202402.1

    Other 3

    Notes

    Changed

  20. v3.202312.1

    Other 3

    Notes

    Changed

    • CAP version 7.4.0
    • Restore openapi export with fix for CAP 7.x
    • Remove node-xlsx and corresponding Export to Excel because this module is causing install issues on Business Application Studio

  21. v3.202311.1

    Other 4

    Notes

    Changed

    • CAP version 7.3.0
    • Major upgrade to Marked for conversion from Markdown in the documentation commands
    • Update to SAPUI5 1.120.1
    • Fix Issue #115 and #116 around the btp-cli commands

  22. v3.202309.1

    Other 6

    Notes

    Changed

    • CAP version 7.2.0
    • New Node.js minimum version of 18. 16 is end of life
    • Load HANA Connection via CDS Env API and profile Hybrid instead of direct binding with cds-dk
    • cds bind based connections are MUCH faster after the first call
    • PostgresSQL and SQLite support on key commands thanks to CDS abstraction
    • Commands: tables and querySimple support profile based access and db abstraction

  23. v3.202308.1

    Other 5

    Notes

    Changed

  24. v3.202307.1

    Other 3

    Notes

    Changed

    • Major new CAP version 7.0.2
    • New minimum Node.js version of 16
    • Tested and supported on Node.js 20.x

  25. v3.202304.2

    Other 1

    Notes

    Changed

    • First round of new unit tests

  26. v3.202304.1

    Other 1

    Notes

    Changed

  27. v3.202303.3

    Other 1

    Notes

    Changed

    • Issue #105 hc, hcstart, and hcstop commands only work with installed btp cli - fixed by HP Seitz

  28. v3.202303.2

    Other 2

    Notes

    Changed

    • Issue #104 noColons option in inspectTable
    • Issue #104 massConvert include user defined types

  29. v3.202303.1

    Other 3

    Notes

    Changed

    • External Dependency Updates - CDS to 6.6.0 (Feb 2023 Update) and SAPUI5 to 1.111.0
    • Switch to Glob 9.x
    • Fix CDS Exit Handler

  30. v3.202302.5

    Other 9

    Notes

    Changed

    • Complete Feature Request Issue 100 Add Views to massConvert
    • Equalize the interface and parameters between inspectTable and inspectView
    • Add new parameters to massConvert to allow logging errors and continue processing rather than stopping on error
    • Add list Views to the Web UI
    • Add inspectView to the Web UI
    • Add link between Views and inspectView in the Web UI
    • External Dependency Updates - CDS-DK to 6.5.2 and SAPUI5 to 1.110.1
    • Add progress bar to the massConvert command in the terminal
    • Add new fancy table output based upon terminal-kit

  31. v3.202302.4

    Other 1

    Notes

    Changed

    • Fix Issue 102 cds compile to sqlite no longer supports quoted

  32. v3.202302.3

    Other 1

    Notes

    Changed

    • Change CDS DEFAULT delimited identifier Issue 98

  33. v3.202302.1

    Other 7

    Notes

    Changed

    • Lazy Load dependent modules to reduce initial command processor boot time - 10x performance improvement
    • CAP Upgrade to Jan 2023 - 6.5.0 version
    • Switch to @json2csv/node as json2csv is abandoned
    • New 'sub' command to list all active BTP Subscriptions and their URLs
    • New 'btpInfo' command to list detailed information about th btp CLI target
    • New 'issue' command to create GitHub issue preloaded with technical details
    • version command now returns information about @sap/cds-dk, the cf cli, and the btp cli

  34. v3.202301.1

    Other 10

    Notes

    Changed

    • Add support for using btp CLI
    • Allows managing HANA Cloud instances that are multi-environment (not managed by Cloud Foundry) - hc, start, stop commands
    • New command: bas - Allows launch the Business Application Studio from the hana-cli
    • New command: btp - Add helper to target BTP Sub Account
    • Improved HANA Cloud Information Formatting
    • Use BTP CLient Config Environment Variable
    • Parallel Loading of all cli commands for performance improvements
    • Updated devcontainer configuration
    • Proper handling if btp CLI is not installed on target machine
    • Fix btp CLI config lookup on Linux

  35. v3.202212.2

    Other 3

    Notes

    Changed

  36. v3.202212.1

    Other 4

    Notes

    Changed

    • Remove the quoted naming as the default and instead put it behind an optional parameter Issue #90
    • CAP October 2022 Release
    • SAPUI5 to version 109.0
    • New Node.js minimal version is 14.18

  37. v3.202210.2

    Other 5

    Notes

    Changed

    • CAP September 2022 Release
    • SAPUI5 to version 107.0
    • Support New CAP Integer Types - TINYINT UInt8 and SMALLINT Int16
    • Support for Postgres in Inspect Table and View
    • Default Values Support Issue #87

  38. v3.202209.3

    Other 2

    Notes

    Changed

  39. v3.202209.2

    Other 1

    Notes

    Changed

  40. v3.202209.1

    Other 3

    Notes

    Changed

  41. v3.202208.1

    Other 3

    Notes

    Changed

    • Update to SAP Cloud Application Programming Model 6.1
    • Adjust cds command read exit logic for changes in 6.1
    • Update to SAPUI5 1.105

  42. v3.202207.1

    Other 1

    Notes

    Changed

    • Update to SAP Cloud Application Programming Model 6.0 (including switch to GraphQL GA version as well as other technical optimizations)

  43. v3.202205.4

    Other 1

    Notes

    Changed

    • Add connection support for cds bind and the resulting .cdsrc-private.json. Note this will make each command take a few seconds longer as credentials are no longer stored locally but looked up from cf or k8s dynamically with each command

  44. v3.202205.3

    Other 4

    Notes

    Changed

    • Issue 74 fixed by Meyer-J
    • Issue 75 fixed by Meyer-J
    • Initial support for Node.js 18. Technically some of the inner modules don't support 18. We've tested many scenarios of this tool with 18. Use at your own risk.
    • Minor dependency updates

  45. v3.202205.1

    Other 3

    Notes

    Changed

  46. v3.202203.3

    Other 3

    Notes

    Changed

  47. v3.202203.2

    Other 2

    Notes

    Changed

    • Fix for connect and incorrect options format for hdb module
    • CDS output escape quotes within comments

  48. v3.202203.1

    Other 2

    Notes

    Changed

    • Various minor dependency updates in used packages
    • SAPUI5 update to 1.99.0

  49. v3.202202.1

    Other 3

    Notes

    Changed

    • Update @sap/cds to Feb 2022 release - 5.8.0
    • inspectTable and inspectView now support graphQL output (CDS Experimental Option)
    • systemInfo new output options - env (display environment connection as JSON) or dbx (display connection details ready to input in the new Database Explorer VSCode Extension)

  50. v3.202201.1

    Other 1

    Notes

    Changed

    • Major New Version: Remove dependency upon @sap/hdbext and @sap/hana-client. Replaced with smaller footprint hdb module.

  51. v2.202201.9

    Other 2

    Notes

    Changed

    • Update the Web UI Web Assistant feature to work with the experimental SAP Horizon theme
    • GraphQL option of cds command now fully works and cross references entity name in the exit correctly

  52. v2.202201.8

    Other 1

    Notes

    Changed

    • Fix Issue #66 - account for different return JSON in cf service-key depending upon if the cf cli is ver 7 or ver 8

  53. v2.202201.7

    Other 1

    Notes

    Changed

  54. v2.202201.1

    Other 3

    Notes

    Changed

    • Updates to support SAP BTP Free Tier and the hana-free service plan
    • createModule command update package.json it produces to support newer versions of Node.js
    • Version dependency updates @sap/hdbext 7.5, @sap/hana-client 2.11.14, @sap/cds to 5.7.4 and SAPUI5 to 1.97.1

  55. v2.202112.1

    Other 4

    Notes

    Changed

    • Upgrade dependencies @sap/hdbext 7.4.1, @sap/hana-client 2.10.20, @sap/cds to 5.6.4 and SAPUI5 to 1.96.1
    • Add first support for GraphQL Experimental (queries don't exit and cross reference table name yet)
    • Switch to SAP_HORIZON new visual theme
    • Support for Node.js 16.x although you might see some warnings for inner packages upon install

  56. v2.202110.1

    Other 1

    Notes

    Changed

    • Upgrade dependencies @sap/hdbext 7.4, @sap/hana-client 2.10.x, @sap/cds to 5.5.5 and SAPUI5 to 1.95.0

  57. v2.202109.2

    Other 2

    Notes

    Changed

    • Tested and made fixes for upcoming Node.js 16.x support. Tested under Node.js 16.9.0. You can use with Node.js 16, but will receive installation warnings and a warning on each command as some packages haven't been fully updated for 16.x yet
    • Upgrade dependencies @sap/hdbext 7.3.7, @sap/hana-client 2.9.28, @sap/cds to 5.4.3 and SAPUI5 to 1.92.1

  58. v2.202109.1

    Other 3

    Notes

    Changed

    • Added status of hana cloud instance to output of command hc by sbarzaghialteaup Pull Request 64
    • Optimize performance for the inspectTable feature in the Browser based UI
    • Switch to the UI5 CodeEditor for output in the inspectTable command in the Browser

  59. v2.202108.4

    Other 4

    Notes

    Changed

    • querySimple Export to CSV Format feature added by sbarzaghialteaup
    • Update Dependencies - especially HANA Client to 2.9.28
    • Update to SAPUI5 1.93.0
    • Convert entire project to ECMAScript Modules (ESM) - this is a massive internal change and we appologize in advance if it results in any instablity. If you hit any issues please report then you can target specifically the last version until they are resolved

  60. v2.202108.1

    Other 4

    Notes

    Changed

    • Update dependencies - especially SAP Cloud Application Programming Model to 5.4.1
    • Trimmed several unused dependencies in an effort to keep hana-cli as slim as possible
    • Remove @sap/cds-dk as a direct dependency. To use the openAPI features in commands like inspectTable, inspectView or cds; you must have @sap/cds-dk globally. But most development environments where this option would be used should already have @sap/cds-dk installed this way. Remove many unneded depenencies and duplicated modules from hana-cli most importantly removing the sqlite3 depenency that was never used but caused lots of install issues.
    • New Browser UI for indexesUI and inspectTableUI

  61. v2.202107.6

    Other 4

    Notes

    Changed

  62. v2.202107.5

    Other 5

    Notes

    Changed

    • Add node.js engines version check on startup and output a warning if there is a mismatch based upon the engines specification in package.json
    • Add busy indicator in browser based UI
    • massConvert to HDBTABLE or HDBMIGRATIONTABLE with the useCatalogPure option now removes CS_* Types from the output for compatibility with target SAP HANA Cloud systems
    • massConvert to HDBTABLE or HDBMIGRATIONTABLE without the useCatalogPure option also includes associations now. However when coming from HDBCDS based sources the column names contain dots which are incompatible with CAP CDS. The associations will still have the old column names while the rest of the table defition must replace the dot with underscore or recieve CDS Compiler errors. I will leave this functionality in place, although imperfect. If you have associations in your source system, strongly consider using the useCatalogPure option instead.
    • Added new commands featuresUI, featureUsageUI, functionsUI, hdiUI, sbssUI, schemaInstancesUI, schemaInstancesUI, securestoreUI, and upsUI

  63. v2.202107.4

    Other 2

    Notes

    Changed

    • version command returned error due to change in latest-version. Reverted to old version of the module
    • Rebuilt npm shrinkwrap due to some install errors with Sqlite3 - errors can be ignored as they don't impact hana-cli but still rather not show errors if possible

  64. v2.202107.3

    Other 4

    Notes

    Changed

    • Allow quoted names in massConvert when the target is HDBTABLE
    • UI theme (light or dark) will now adjust automatically to user's OS setting
    • New commands: containersUI, dataTypesUI, schemasUI, and tablesUI
    • Refactored list operations (like schemas, tables, etc) to allow them to be reused in the new Browser UI

  65. v2.202107.2

    Other 3

    Notes

    Changed

    • Upgrade to @sap/cds 5.3.1, @sap/hana-client 2.9.23, @sap/hdbext 7.3.0, and sap-hdbext-promisifed 2.202107.1
    • Major addition of new browser based UIs for certain complex commands. First focus is on the massConvert command. No new external depencencies. We launch Express web server from the CLI and then open the web browser. You can complete the command with visual options, value help and extended documentation. Command is still executed in the CLI and the output is piped to the web broswer using web sockets.
    • New commands: massConvertUI, systemInfoUI, changesUI, readMeUI, and UI (last one opens a LaunchPad with tiles for all the other commands)

  66. v2.202107.1

    Other 3

    Notes

    Changed

  67. v2.202106.3

    Other 1

    Notes

    Changed

    • massConvert - change require('fs/promises') to require('fs').promises for compatibility with Node 12.x - see Update fs.md #35740

  68. v2.202106.2

    Other 1

    Notes

    Changed

    • New commands schemaInstances, securestore, and sbss to list cf/xs services instances of these plan types

  69. v2.202106.1

    Other 3

    Notes

    Changed

  70. v2.202105.9

    Other 4

    Notes

    Changed

  71. v2.202105.8

    Other 2

    Notes

    Changed

    • Added hana client disconnect at error and normal end conditions to avoid segmentation fault in WSL and slightly older versions of Node.js - thanks to sbarzaghialteaup
    • First round of TypeScript types inclusion - more to come. Will mostly help project maintainers

  72. v2.202105.6

    Other 3

    Notes

    Changed

    • Missing npm shrinkwrap in last release
    • Improved details in thrown errors and added debug info from util/cf and util/xs
    • hana-cli version now reports latest avaialble version on npm and propmpts users to upgrade if they are outdated

  73. v2.202105.5

    Other 6

    Notes

    Changed

    • @cds dependency updated to May 2021 release 5.1.4
    • Update cds preview to UI5 1.89.0
    • cds preview new parameter to allow use to choose HTTP port (and validate that input)
    • Issue #42 Optional namespace for generated cds - thanks to @ThePlenkov
    • serviceKey command no longer requires to pre-create the service key. If the key you specify doesn't exist it will call cf/xs create-service-key for you automatically Issue #41
    • Increase the page size for the xs/cf services commands (ups and hdi) Issue #40

  74. v2.202105.4

    Other 4

    Notes

    Changed

  75. v2.202105.3

    Other 2

    Notes

    Changed

    • Upgraded dependencies @sap/cds to 5.1, @sap/hana-client to 2.8.20, and @sap/hdbext to 7.2.0
    • Add User Admin and Role Admin grants to the adminHDI and adminHDIGroup commands for XSA

  76. v2.202105.2

    Other 1

    Notes

    Changed

    • quiet output added to most commands allowing for a wide range of scripted usage of the tool overall

  77. v2.202105.1

    Other 3

    Notes

    Changed

    • copy2DefaultEnv fix to support hanatrial (old HaaS offering) but produce a warning that people should consider using SAP HANA Cloud trial instead
    • Fix not a function error in inspectView with output option of openapi
    • swagger-jsdoc output format, which is actually commented YAML version of openAPI, added to inspectTable and inspectView

  78. v2.202104.2

    Other 15

    Notes

    Changed

    • Match the @sap/hdbext and @sap/hana-client versions exactly to remove duplicate copies of the HANA Client in node_modules removing about 135Mb from the footprint of this tool overall
    • Major internal refactoring to streamline the code and reduce duplication. Reusable base code for basic handling of Yargs and Prompts. Consistent error handling and other general stability improvments
    • The default-env*.json file no longer needs to be in the same directory in which you are running the command. If not found in the current directory, the tool will search in up to 5 parent directories to find it
    • New parameter --conn added to most commands that allow you specify any filename you want to override the default-env.json. conn can specify a file in the current directory, up to 5 parent directories or in your ${homedir}/.hana-cli/ folder
    • New parameter --quiet that disables extra output and human readable formatting for when you want to script commands and get pure results output
    • New parameter --debug - for troubleshooting of the hana-cli tool itself. It will produce a LOT of detailed output. Nice if you are curious what queries are being sent to SAP to fullfill a command
    • Options in the help are now grouped by Conneciton Parameters, Troubleshooting, and Options
    • New order of processing for making connections as follows:
    • First we look for the Admin option and use a default-env-admin.json - this overrides all other parameters
    • If no admin option or if there was an admin option but no default-env-admin.json could be found in this directory or 5 parent directories then look for a .env file in this directory or up to 5 parent directories
    • No .env file found or it doesn't contain a VCAP_SERVICES section, then check to see if the --conn parameter was specified. If so check for that file in the current directory or up to 5 parent directories
    • If the file specified via the --conn parameter wasn't found locally then check for it in the ${homedir}/.hana-cli/ folder
    • If no specific configuration file was was found then look for a file named default-env.json in the current directory or up to 5 parent directories
    • Last resort if nothing has been found up to this point - look for a file named default.json in the ${homedir}/.hana-cli/ folder
    • Add Syntax Highlighting to various command outputs

  79. v2.202104.1

    Other 5

    Notes

    Changed

    • New Inspect* output options for sqlite, hdbtable, hdbview and hdbcds
    • Upgrade to @sap/cds 5.x
    • Drop support for Node.js version 10
    • cds preview updated to SAPUI5 1.88.1
    • connect command now prompts for Encyrypt setting

  80. v2.202103.4

    Other 2

    Notes

    Changed

    • New command copy2Secrets to rewrite default-env.json as K8S Secrets format expected by @sap/xsenv - Pull Request 35
    • thanks to @ThePlenkov

  81. v2.202103.3

    Other 2

    Notes

    Changed

    • querySimple now allows output to a file and supports table, json, and Excel output formats Issue #30
    • README.md was reorganized to list all commands alphabetical Issue [#31](https: //github.com/SAP-samples/hana-developer-cli-tool-example/issues/31)

  82. v2.202103.2

    Other 2

    Notes

    Changed

    • Option to massConvert, inspectTable, inspectView, and cds to use HANA native data types if no CAP CDS direct conversion can be made. Issue #27 - thanks to @ThePlenkov
    • Decimal types without decismals generates CDS Error. Issue #29 - thanks to @ThePlenkov

  83. v2.202103.1

    Other 5

    Notes

    Changed

    • New commands: changes & readme - output the CHANGELOG.md and README.md to the CLI
    • Issue #25 - Add filename option to massConvertion Operation - thanks to @ThePlenkov
    • Updated several dependent modules including hana-client
    • Put hana-cli on a diet and removed some old module dependencies no longer used. Especially the openAPI related ones which had functionality now offered by CAP directly
    • help command now lists all commands in alphabetical order

  84. v2.202102.4

    Other 1

    Notes

    Changed

    • HANA 1.0 Support - Issue #22

  85. v2.202102.3

    Other 9

    Notes

    Changed

    • Updated @sap/textbundle
    • Add readme command that opens ReadMe Documentation in your browser
    • Add changelog command that opens Change Log in your browser
    • Formatting of output copy2DefaultEnv improved for compatibility to CAP cds run
    • New command copy2Env - copy default-env.json to .env and reformat contents
    • Support for HANA Cloud Instance Administration - requires cf cli to be installed and you must be logged into cf with a target org and space
    • Added Command: hdi to list all SAP HANA Cloud HDI container instances in your target space
    • Added Command: ups to list all Cloud Foundry user provided service instances in your target space
    • Switch to the standard CAP Compile to openAPI in inspectTable, inspectView and cds commands. Now supports entity diagrams in the Swagger UI

  86. v2.202102.2

    Other 5

    Notes

    Changed

    • Updated @sap/cds to 4.5.x
    • Support for HANA Cloud Instance Administration - requires cf cli to be installed and you must be logged into cf with a target org and space
    • Added Command: hc to list all SAP HANA Cloud instances in your target space
    • Added Command: hcStart to Start SAP HANA Cloud instance
    • Added Command: hcStop to Stop SAP HANA Cloud instance

  87. v2.202102.1

    Other 1

    Notes

    Changed

    • serviceKey cf default was incorrect

  88. v2.202101.3

    Other 2

    Notes

    Changed

    • Renaming to match new SAP Business Technology Platform branding
    • Minor dependent package version updates

  89. v2.202101.2

    Other 2

    Notes

    Changed

    • Default value on createModule command changed to SAP HANA Cloud
    • Remove postinstall build script from SAP HANA Cloud option - only needed in SAP Web IDE

  90. v2.202101.1

    Other 6

    Notes

    Changed

    • Update @sap/hana-client to v2.7.16, @sap/cds to 4.4.7 and sap-hdbext-promisfied to 2.202101
    • Correct dump if you run hana-cli with no commmand, no defaults to help command
    • Correct error when using .env for connections and there are multiple SAP HANA and User Provided Services both in the configuration
    • Correct openDBX command in SAP Business Application Studio when using .env for connections
    • Node.js 14.x support
    • New command copy2DefaultEnv - which copies a .env file to default-env.json and reformats the content. Designed for SAP Business Application Studio and the HANA tooling where a .env file is generated by a binding but CAP still requires a default-env.json for testing
On GitHub

Others providing43

Agent access to your systems
  1. mcp-integration-suiteMCP server for the general Integration Suite functionsfrom BTP/BAIP
  2. mcp-is-tpmJava MCP server for Integration Suite Trading Partner Managementfrom BTP/BAIP
  3. @abap2ui5/mcp-serverMCP server for the abap2UI5 check, deploy and run loopfrom ABAP
  4. abap2UI5 for VS CodeVS Code extension to preview, activate and lint abap2UI5 appsfrom ABAP
  5. SF-MCPMCP server with 62 tools over SAP SuccessFactors OData APIsfrom SAP SuccessFactors
  6. hybris-mcp-liteRead-only MCP server over a local SAP Commerce Cloud's HACfrom SAP Commerce
  7. calmcpMCP server with read tools over the SAP Cloud ALM APIsfrom BTP/BAIP
  8. CostingGeek/sap-mcpPython MCP server fetching sales orders from SAP's business data graphfrom BTP/BAIP
  9. mcp-sap-focusedrunMCP tools over SAP Focused Run's Landscape Management Databasefrom BTP/BAIP
  10. abapsmithABAP MCP server over ADT with a local journal that can undo writesfrom ABAP
  11. cloud-alm-itsm-mcpMCP server querying installations via the SAP Cloud ALM ITSM APIfrom BTP/BAIP
  12. hana-mcp-serverMCP server for schema discovery and guarded SQL on SAP HANAfrom BTP/BAIP
  13. sap_analytics_cloud_mcpMCP server for the SAP Analytics Cloud REST APIfrom BTP/BAIP
  14. mcp-sap-cpiMCP server for Cloud Integration runtime: messages, logs, deploymentfrom BTP/BAIP
  15. AI Core MCP ServerSAP AI Core APIs as MCP tools from one JSON config filefrom BTP/BAIP
  16. BTP CF MCP ServerCloud Foundry V3 API on SAP BTP as MCP toolsfrom BTP/BAIP
  17. BTP MCP ServerBTP Core Services as MCP tools with in-chat dashboardsfrom BTP/BAIP
  18. btp-sap-odata-to-mcp-serverExposes S/4HANA or ECC OData services as MCP toolsfrom BTP/BAIP
  19. CI MCP ServerSAP Cloud Integration OData APIs as MCP toolsfrom BTP/BAIP
  20. odata-mcp-proxyConfig-driven proxy turning OData and REST endpoints into MCP toolsfrom BTP/BAIP
  21. sap-pi-mcp-serverMCP server for SAP PI and PO monitoring and directory metadatafrom BTP/BAIP
  22. sap-bdc-mcp-serverMCP server managing Delta shares in SAP Business Data Cloudfrom BTP/BAIP
  23. @mariodefe/sap-datasphere-mcpMCP server with forty-five tools across a Datasphere tenantfrom BTP/BAIP
  24. midasol/sap-mcp-serverPython MCP server for SAP Gateway OData operationsfrom BTP/BAIP
  25. odata_mcp_goGo binary bridging any OData v2 or v4 service to MCPfrom BTP/BAIP
  26. odata_mcpPython bridge generating MCP tools from OData v2 metadatafrom BTP/BAIP
  27. sap-bdc-mcpMCP tooling for SAP Business Data Cloud discovery and contractsfrom BTP/BAIP
  28. mcp-sap-datasphere-serverRead-only MCP server for exploring SAP Dataspherefrom BTP/BAIP
  29. sap-mcp-serverReads SAP ECC and S/4HANA for an agent over Gateway OData and RFC, with a Node bridge that speaks the RFC protocol without the proprietary SAP NetWeaver RFC SDK.from ABAP
  30. cap-mcp-bridgeMCP server generating tools from a CAP or OData V4 service's metadatafrom CAP
  31. MCP Server for SAP BTP AdministrationSAP-hosted MCP endpoint for BTP account administrationfrom BTP/BAIP
  32. SAP LeanIX MCP ServerHosted MCP endpoint onto an SAP LeanIX instancefrom BTP/BAIP
  33. SAP-samples/hana-cli-claude-pluginClaude Code plugin registering hana-cli's MCP serverfrom BTP/BAIP
  34. Skybuffer AI MCP serverABAP add-on serving business data and transactions as MCP toolsfrom ABAP
  35. sap-security-mcpRead-only security analysis MCP server for SAP audits and SoD reviewfrom ABAP
  36. cpi-mcp-serverGo MCP server over Cloud Integration packages and integration flowsfrom BTP/BAIP
  37. KlystronMCP server in ABAP inside the application server, with agent skillsfrom ABAP
  38. pyrfc-mcpMCP server calling RFC-enabled function modules behind an allowlistfrom ABAP
Native SAP HANA artifacts
  1. cds-federation-synonymsCAP-to-CAP data federation over SAP HANA synonymsfrom CAP
  2. @sap/cds-dkCommand line client and development toolkit for CAPfrom CAP
  3. @sap/cdsCAP Node.js runtimefrom CAP
  4. @sap/hdi-deployNode.js deployer for SAP HANA Deployment Infrastructure containersfrom CAP
Database administration
  1. SAP HANA CloudManaged SAP HANA database service on BTPfrom BTP/BAIP

Details

Sources4
GitHub organisations and accountsdiscovered herechecked
npm registry, SAP-samples/hana-developer-cli-tool-exampleversion, releases, installschecked
github.com/SAP-samples/hana-developer-cli-tool-exampletree, pushes, contributors, CIchecked
README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
runtimesnode
discovered viaGitHub organisations and accounts
first seen in the atlas
ecosystem and domainbtp, data-and-persistence
Contributors8
HP SeitzAjinkya PatilBrian BernardGregor WolfThomas JungJoerg MeyerSamuele BarzaghiPetr Plenkov

From the repository’s contributor list, .

History in the atlas3
  1. capability:agent-systems-access and capability:hana-native-artifacts; serves cap; domain data-and-persistence
  2. adds capability:database-administration
  3. First seen.
For your agent
Ref
artifact:sap-samples-hana-developer-cli-tool-example
JSON
/artifacts/sap-samples-hana-developer-cli-tool-example.json
MCP
Connecting an agent