UNPKG

hana-cli

Version:
144 lines (92 loc) โ€ข 4.81 kB
--- # https://vitepress.dev/reference/default-theme-home-page layout: home title: SAP HANA Developer CLI - Documentation hero: name: "SAP HANA Developer Command Line Interface" image: /logo.png tagline: Welcome to the official documentation for the SAP HANA Developer Command Line Interface. A developer-centric tool for working with SAP HANA databases from your terminal, IDE, or cloud shell environment --- ::: warning โš ๏ธ 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](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues) - **Rollback:** Install the last stable version: `npm install -g hana-cli@3.202601.0` See the [Changelog](/99-reference/changelog) for complete details on all changes. ::: ## ๐Ÿš€ Quick Links <div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;"> <div style="border: 1px solid #e3e6f0; border-radius: 8px; padding: 20px;"> ### โšก Getting Started New to hana-cli? Start here with installation and first steps. [Get Started โ†’](/01-getting-started/) </div> <div style="border: 1px solid #e3e6f0; border-radius: 8px; padding: 20px;"> ### ๐Ÿ“š Commands Explore 155 commands organized by category. [Browse Commands โ†’](/02-commands/) </div> <div style="border: 1px solid #e3e6f0; border-radius: 8px; padding: 20px;"> ### โœจ Features Learn about advanced features and integrations. [Features โ†’](/03-features/) </div> <div style="border: 1px solid #e3e6f0; border-radius: 8px; padding: 20px;"> ### ๐Ÿ”Œ API Reference Integration guides and API documentation. [API Docs โ†’](/04-api-reference/) </div> <div style="border: 1px solid #e3e6f0; border-radius: 8px; padding: 20px;"> ### ๐Ÿงช Testing & QA Run E2E CLI tests and WDI5 UI automation. [Testing Guide โ†’](/05-development/testing.md) </div> </div> ## What is HANA CLI? HANA CLI (pronounced "HAN-uh C-L-I") is a powerful command-line tool designed for SAP HANA developers. Whether you're working locally with SAP HANA Express, in the cloud with SAP BTP, or with SAP HANA Cloud, this tool simplifies complex database operations. ### Key Features - **Data Analysis** - Profile, compare, and validate data with precision - **Schema Management** - Clone, compare, and sync database schemas - **Data Import/Export** - Seamless CSV and Excel file handling - **API Server** - REST API for programmatic access - **Model Context Protocol** - Integration with AI coding assistants - **Multi-Environment** - Works anywhere Node.js runs (tested on Windows, macOS, and Linux) ## ๐Ÿ“– Popular Topics - [Installation Guide](/01-getting-started/installation.md) - [Quick Start Tutorial](/01-getting-started/quick-start.md) - [Import Data from CSV](/02-commands/data-tools/import.md) - [Compare Database Schemas](/02-commands/schema-tools/compare-schema.md) - [Data Profiling & Analysis](/02-commands/analysis-tools/data-profile.md) - [Set Up MCP Server](/03-features/mcp-integration.md) - [Testing & QA (E2E + UI)](/05-development/testing.md) ## ๐ŸŽฅ Videos - [Introduction Tutorial](https://youtu.be/dvVQfi9Qgog) - [Running in Cloud Shells](https://youtu.be/L7QyVLvAIIQ) ## ๐Ÿ’ก Use Cases ### Local Development - VSCode + SAP HANA Express development or [CDS Projects with SAP HANA Cloud remote binding](https://cap.cloud.sap/docs/tools/cds-bind#run-with-service-bindings) - Quick database queries and schema changes - Data validation and testing ### Cloud Development - SAP Business Application Studio integration - Cloud shell environments (Google Cloud, AWS) - SAP BTP HANA service management ### Data Operations - ETL and data migration - Data quality validation - Schema synchronization across environments ## ๐Ÿ”— Resources - [GitHub Repository](https://github.com/SAP-samples/hana-developer-cli-tool-example) - [NPM Package](https://www.npmjs.com/package/hana-cli) - [SAP Community](https://community.sap.com) - [License](https://github.com/SAP-samples/hana-developer-cli-tool-example/blob/main/LICENSE) ## ๐Ÿ“ Need Help? - Check the [Frequently Asked Questions](./99-reference/faq-extended.md) - Review [Troubleshooting Guide](./troubleshooting/) - Search the documentation above - Open an issue on [GitHub](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues) --- :::info **Just getting started?** Head over to the [Getting Started guide](/01-getting-started/) to install and configure HANA CLI in just a few minutes. :::