Getting Started

Welcome! This section covers everything you need to get started with the SAP HANA Developer CLI.

Installation

HANA CLI is available through npm for quick installation:

npm install -g hana-cli

Or build from source:

git clone https://github.com/SAP-samples/hana-developer-cli-tool-example
cd hana-developer-cli-tool-example
npm install
npm link

Requirements

• Node.js 14.x or 16.x
• Access to a SAP HANA database

Full Installation Guide →

Quick Start

Get up and running in 5 minutes:

# Verify installation
hana-cli --version

# Show available commands
hana-cli --help

# Connect to your HANA instance
hana-cli alerts -h

Quick Start Tutorial →

Configuration

Set up connection details via default-env.json:

{
  "VCAP_SERVICES": {
    "hana": [{
      "credentials": {
        "host": "your-hana-server.com",
        "port": 30013,
        "user": "DBUSER",
        "password": "****"
      }
    }]
  }
}

Configuration Guide →

Supported Environments

• Local Development: VSCode with SAP HANA Express
• Cloud: SAP Business Application Studio, Google Cloud Shell, AWS Cloud9
• Services: SAP BTP HANA, SAP HANA Cloud

Environments Guide →

Next Steps

• Explore Commands
• Learn Features
• View API Reference