@sap/datasphere-cli 2023.14.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project SAP Datasphere Command-Line Interface (DS CLI) will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 2023.10.0
+
+Package `@sap/datasphere-cli` was released.

package/LICENSE

@@ -0,0 +1,44 @@
+SAP FREEWARE LICENSE AGREEMENT 
+
+Please scroll down and read the following SAP Freeware License Agreement carefully ("Agreement"). By downloading, installing, or otherwise using the SAP Freeware or any materials that accompany the Freeware documentation (collectively, the "Freeware"), You agree that this Agreement forms a legally binding agreement between You ("You" or "Your") and SAP SE, for and on behalf of itself and its subsidiaries and affiliates (as defined in Section 15 of the German Stock Corporation Act), and You agree to be bound by all of the terms and conditions stated in this Agreement. If You are trying to access or download the Freeware on behalf of Your employer or as a consultant or agent of a third party (either "Your Company"), You represent and warrant that You have the authority to act on behalf of and bind Your Company to the terms of this Agreement and everywhere in this Agreement that refers to 'You' or 'Your' shall also include Your Company. If You do not agree to these terms, do not attempt to access or use the Freeware. 
+
+1. LICENSE: Subject to the terms of this Agreement, SAP grants You a non- exclusive, non-transferable, non-sublicensable, revocable, royalty-free, limited license to use and copy the Freeware solely for Your internal business purposes. 
+
+2. RESTRICTIONS: You must not use the Freeware to: (a) impair, degrade or reduce the performance or security of any SAP products, services or related technology (collectively, "SAP Products"); (b) enable the bypassing or circumventing of SAP's license restrictions and/or provide users with access to the SAP Products to which such users are not licensed; or (c) permit mass data extraction from an SAP Product to a non-SAP Product, including use, modification, saving or other processing of such data in the non-SAP Product. Further, You must not: (i) provide or make the Freeware available to any third party other than your authorized employees, contractors and agents (collectively, "Representatives") and solely to be used by Your Representatives for Your own internal business purposes; ii) remove or modify any marks or proprietary notices from the Freeware; iii) assign this Agreement, or any interest therein, to any third party; (iv) use any SAP name, trademark or logo without the prior written authorization of SAP; or (v) use the Freeware to modify an SAP Product or decompile, disassemble or reverse engineer an SAP Product (except to the extent permitted by applicable law). You are responsible for any breach of the terms of this Agreement by You or Your Representatives. 
+
+3. INTELLECTUAL PROPERTY: SAP or its licensors retain all ownership and intellectual property rights in and to the Freeware and SAP Products. In exchange for the right to use and copy the Freeware provided under this Agreement, You covenant not to assert any intellectual property rights in or to any of Your products, services, or related technology that are based on or incorporate the Freeware against any individual or entity in respect of any current or future SAP Products. 
+
+4. SAP AND THIRD PARTY APIS: The Freeware may include API (application programming interface) calls to SAP and third-party products or services. The access or use of the third-party products and services to which the API calls are directed may be subject to additional terms and conditions between you and SAP or such third parties. You (and not SAP) are solely responsible for understanding and complying with any additional terms and conditions that apply to the access or use of those APIs and/or third-party products and 
+services. SAP does not grant You any rights in or to these APIs, products or services under this Agreement. 
+
+5. FREE AND OPEN SOURCE COMPONENTS: The Freeware may include third party free or open source components ("FOSS Components"). You may have additional rights in such FOSS Components that are provided by the third party licensors of those components. 
+
+6. THIRD PARTY DEPENDENCIES: The Freeware may require third party software dependencies ("Dependencies") for the use or operation of the Freeware. These Dependencies may be identified by SAP in Maven POM files, documentation or by other means. SAP does not grant You any rights in or to such Dependencies under this Agreement. You are solely responsible for the acquisition, installation and use of such Dependencies. 
+
+7. WARRANTY:
+a) If You are located outside the US or Canada: AS THE FREEWARE IS PROVIDED TO YOU FREE OF CHARGE, SAP DOES NOT GUARANTEE OR WARRANT ANY FEATURES OR QUALITIES OF THE FREEWARE OR GIVE ANY UNDERTAKING WITH REGARD TO ANY OTHER QUALITY. NO SUCH WARRANTY OR UNDERTAKING SHALL BE IMPLIED BY YOU FROM ANY DESCRIPTION IN THE FREEWARE OR ANY OTHER MATERIALS, COMMUNICATION OR ADVERTISEMENT. IN PARTICULAR, SAP DOES NOT WARRANT THAT THE FREEWARE WILL BE AVAILABLE UNINTERRUPTED, ERROR FREE, OR PERMANENTLY AVAILABLE. ALL WARRANTY CLAIMS RESPECTING THE FREEWARE ARE SUBJECT TO THE LIMITATION OF LIABILITY STIPULATED IN SECTION 8 BELOW.
+b) If You are located in the US or Canada: THE FREEWARE IS LICENSED TO YOU "AS IS", WITHOUT ANY WARRANTY, ESCROW, TRAINING, MAINTENANCE, OR SERVICE OBLIGATIONS WHATSOEVER ON THE PART OF SAP. SAP MAKES NO EXPRESS OR IMPLIED WARRANTIES OR CONDITIONS OF SALE OF ANY TYPE WHATSOEVER, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND OF FITNESS FOR A PARTICULAR PURPOSE. IN PARTICULAR, SAP DOES NOT WARRANT THAT THE FREEWARE WILL BE AVAILABLE UNINTERRUPTED, ERROR FREE, OR PERMANENTLY AVAILABLE. YOU ASSUME ALL RISKS ASSOCIATED WITH THE USE OF THE FREEWARE, INCLUDING WITHOUT LIMITATION RISKS RELATING TO QUALITY, AVAILABILITY, PERFORMANCE, DATA LOSS, AND UTILITY IN A PRODUCTION ENVIRONMENT.
+c) For all locations: SAP DOES NOT MAKE ANY REPRESENTATIONS OR WARRANTIES IN RESPECT OF THIRD PARTY DEPENDENCIES, APIS, PRODUCTS AND SERVICES, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND OF FITNESS FOR A PARTICULAR PURPOSE. IN PARTICULAR, SAP DOES NOT WARRANT THAT THIRD- PARTY DEPENDENCIES, APIS, PRODUCTS AND SERVICES WILL BE AVAILABLE, ERROR FREE, INTEROPERABLE WITH THE FREEWARE, SUITABLE FOR ANY PARTICULAR PURPOSE OR NON- INFRINGING. YOU ASSUME ALL RISKS ASSOCIATED WITH THE USE OF THIRD PARTY DEPENDENCIES, APIS, PRODUCTS AND SERVICES, INCLUDING WITHOUT LIMITATION RISKS RELATING TO QUALITY, AVAILABILITY, PERFORMANCE, DATA LOSS, UTILITY IN A PRODUCTION ENVIRONMENT, AND NON-INFRINGEMENT. IN NO EVENT WILL SAP BE LIABLE DIRECTLY OR INDIRECTLY IN RESPECT OF ANY USE OF THIRD PARTY DEPENDENCIES, APIS, PRODUCTS AND SERVICES BY YOU. 
+
+8. LIMITATION OF LIABILITY:
+a) If You are located outside the US or Canada: IRRESPECTIVE OF THE LEGAL REASONS, SAP SHALL ONLY BE LIABLE FOR DAMAGES UNDER THIS AGREEMENT IF SUCH DAMAGE (I) CAN BE CLAIMED UNDER THE GERMAN PRODUCT LIABILITY ACT OR (II) IS CAUSED BY INTENTIONAL MISCONDUCT OF SAP OR (III) CONSISTS OF PERSONAL INJURY. IN ALL OTHER CASES, NEITHER SAP NOR ITS EMPLOYEES, AGENTS AND SUBCONTRACTORS SHALL BE LIABLE FOR ANY KIND OF DAMAGE OR CLAIMS HEREUNDER.
+b) If You are located in the US or Canada: IN NO EVENT SHALL SAP BE LIABLE TO 
+YOU, YOUR COMPANY OR TO ANY THIRD PARTY FOR ANY DAMAGES IN AN AMOUNT IN EXCESS OF $100 ARISING IN CONNECTION WITH YOUR USE OF OR INABILITY TO USE THE FREEWARE OR IN CONNECTION WITH SAP'S PROVISION OF OR FAILURE TO PROVIDE SERVICES 
+PERTAINING TO THE FREEWARE, OR AS A RESULT OF ANY DEFECT IN THE FREEWARE. THIS DISCLAIMER OF LIABILITY SHALL APPLY REGARDLESS OF THE FORM OF ACTION THAT MAY BE BROUGHT AGAINST SAP, WHETHER IN CONTRACT OR TORT, INCLUDING WITHOUT LIMITATION ANY ACTION FOR NEGLIGENCE. YOUR SOLE REMEDY IN THE EVENT OF BREACH OF THIS AGREEMENT BY SAP OR FOR ANY OTHER CLAIM RELATED TO THE FREEWARE SHALL BE TERMINATION OF THIS AGREEMENT. NOTWITHSTANDING ANYTHING TO THE CONTRARY HEREIN, UNDER NO CIRCUMSTANCES SHALL SAP OR ITS LICENSORS BE LIABLE TO YOU OR ANY OTHER PERSON OR ENTITY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR INDIRECT DAMAGES, LOSS OF GOOD WILL OR BUSINESS PROFITS, WORK STOPPAGE, DATA LOSS, COMPUTER FAILURE OR MALFUNCTION, ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSS, OR EXEMPLARY OR PUNITIVE DAMAGES. 
+
+9. INDEMNITY: You will fully indemnify, hold harmless and defend SAP against law suits based on any claim: (a) that any of Your products, services or related technology that are based on or incorporate the Freeware infringes or misappropriates any patent, copyright, trademark, trade secrets, or other proprietary rights of a third party, or (b) related to Your alleged violation of the terms of this Agreement. 
+
+10. EXPORT: The Freeware is subject to German, EU and US export control regulations. You confirm that: a) You will not use the Freeware for, and will not allow the Freeware to be used for, any purposes prohibited by German, EU and US law, including, without limitation, for the development, design, manufacture or production of nuclear, chemical or biological weapons of mass destruction; b) You are not located in Cuba, Iran, Sudan, Iraq, North Korea, Syria, nor any other country to which the United States has prohibited export or that has been designated by the U.S. Government as a "terrorist supporting" country (any, an "US Embargoed Country"); c) You are not a citizen, national or resident of, and are not under the control of, a US Embargoed Country; d) You will not download or otherwise export or re-export the Freeware, directly or indirectly, to a US Embargoed Country nor to citizens, nationals or residents of a US Embargoed Country; e) You are not listed on the United States Department of Treasury lists of Specially Designated Nationals, Specially Designated Terrorists, and Specially Designated Narcotic Traffickers, nor listed on the United States Department of Commerce Table of Denial Orders or any other U.S. government list of prohibited or restricted parties and f) You will not download or otherwise export or re-export the Freeware, directly or indirectly, to persons on the above-mentioned lists. 
+
+11. SUPPORT: SAP does not offer support for the Freeware. 
+
+12. TERM AND TERMINATION: You may terminate this Agreement by destroying all copies of the Freeware in Your possession or control. SAP may terminate Your license to use the Freeware immediately if You fail to comply with any of the terms of this Agreement, or, for SAP's convenience by providing you with ten (10) days written notice of termination. In case of termination or expiration of this Agreement, You must immediately destroy all copies of the Freeware in your possession or control. In the event Your Company is acquired (by merger, purchase of stock, assets or intellectual property or exclusive license), or You become employed, by a direct competitor of SAP, then this Agreement and 
+all licenses granted to You in this Agreement shall immediately terminate upon the date of such acquisition or change of employment. 
+
+13. LAW/VENUE:
+a) If You are located outside the US or Canada: This Agreement is governed by and construed in accordance with the laws of Germany without reference to its conflicts of law principles. You and SAP agree to submit to the exclusive 
+jurisdiction of, and venue in, the courts located in Karlsruhe, Germany in any dispute arising out of or relating to this Agreement or the Freeware. The United Nations Convention on Contracts for the International Sale of Goods shall not apply to this Agreement. 
+b) If You are located in the US or Canada: This Agreement shall be governed by and construed in accordance with the laws of the State of New York, USA without reference to its conflicts of law principles. You and SAP agree to submit to the exclusive jurisdiction of, and venue in, the courts located in New York, New York, USA in any dispute arising out of or relating to this Agreement or the Freeware. The United Nations Convention on Contracts for the International Sale of Goods shall not apply to this Agreement. 
+
+14. MISCELLANEOUS: This Agreement is the complete agreement between the parties respecting the Freeware. This Agreement supersedes all prior or contemporaneous agreements or representations with regards to the Freeware. If any term of this Agreement is found to be invalid or unenforceable, the surviving provisions shall remain effective. SAP's failure to enforce any right or provisions stipulated in this Agreement will not constitute a waiver of such provision, or any other provision of this Agreement. 
+

package/README.md

@@ -0,0 +1,471 @@
+# @sap/datasphere-cli
+
+Command-Line Interface (CLI) for SAP Datasphere.
+
+[![Node Version](https://img.shields.io/badge/node-16.xx.x-brightgreen)](https://nodejs.org/dist/latest-v16.x/docs/api/#) [![npm version](https://badge.fury.io/js/@sap%2Fdatasphere-cli.svg)](https://badge.fury.io/js/@sap%2Fdatasphere-cli) [![Documentation](https://img.shields.io/badge/docs-online-ff69b4.svg)](https://help.sap.com/docs/SAP_DATASPHERE/d0ecd6f297ac40249072a44df0549c1a/3f9a42ccde6b4b6aba121e2aab79c36d.html) [![Command help pages](https://img.shields.io/badge/command-help-lightgrey.svg)](#usage) ![NPM](https://img.shields.io/npm/l/@sap/datasphere-cli?color=%23FFFF00)
+
+## Content
+
+1. [Installation](#installation)
+1. [Update the CLI](#update-the-cli)
+1. [Versioning](#versioning)
+1. [Authentication](#authentication)
+   1. [OAuth Interactive Usage](#oauth-interactive-usage)
+   1. [Passcodes](#passcodes)
+1. [Usage](#usage)
+   1. [From the command line](#from-the-command-line)
+   1. [As a Node.js module dependency](#as-a-nodejs-module-dependency)
+   1. [Options Handling](#options-handling)
+   1. [Environment Variables](#environment-variables)
+1. [Help & Documentation](#help-documentation)
+1. [Community & Feedback](#community--feedback)
+1. [License](#license)
+
+## Installation
+
+```bash
+$ npm install -g @sap/datasphere-cli
+```
+
+or
+
+```bash
+$ yarn global add @sap/datasphere-cli
+```
+
+## Update the CLI
+
+See [Installation](#installation).
+
+In case of structural changes applied to the service document (see [Initialize the CLI](#initialize-the-cli)) with a new version of SAP Datasphere you need to update the CLI. In this case, after you executed a command, the CLI issues a warning:
+
+```bash
+$ datasphere <command>
+Your local CLI installation is outdated. Run 'npm install @sap/datasphere-cli [-g]' to update
+```
+
+## Versioning
+
+The semantic versioning of the CLI is handled according to SAP Datasphere versions and follows the same structure for major and minor versions.
+
+```bash
+$ datasphere -v
+2021.21.0
+```
+
+For an in-depth explanation see the blog post on [blogs.sap.com](https://blogs.sap.com/2021/09/21/new-command-line-for-sap-data-warehouse-cloud-code-way-to-the-cloud/).
+
+## Authentication
+
+### OAuth Interactive Usage
+
+You can create an [OAuth Client for Interactive Usage](https://help.sap.com/docs/SAP_DATASPHERE/c8a54ee704e94e15926551293243fd1d/3f92b46fe0314e8ba60720e409c219fc.html) and authenticate using the provided _Client ID_ and _Client Secret_. After you created an OAuth Client for Interactive Usage, you can log in once and run multiple commands without the need to authenticate again for the next 720 hours.
+
+To log in, run the `login` command and provide the _Client ID_, _Client Secret_, _Authentication URL_, and _Token URL_, available from your SAP Datasphere tenant ([SAP Help](https://help.sap.com/docs/SAP_DATASPHERE/c8a54ee704e94e15926551293243fd1d/3f92b46fe0314e8ba60720e409c219fc.html)).
+
+```bash
+$ datasphere login
+✔ Please enter your client ID: … <Client ID>
+✔ Please enter your client secret: … ****
+✔ Please enter your authorization URL: … <Authorization URL>
+✔ Please enter your token URL: … <Token URL>
+```
+
+To remove any data stored by running the `login` command, log out again:
+
+```bash
+$ datasphere logout
+```
+
+To display the locally stored secrets, run the `secrets show` command:
+
+```bash
+$ datasphere secrets show
+{
+  "client_id": "...",
+  "client_secret": "...",
+  "authorization_url": "...",
+  "token_url": "...",
+  "access_token": "...",
+  "token_type": "...",
+  "id_token": "...",
+  "refresh_token": "...",
+  "expires_in": ...,
+  "scope": "...",
+  "jti": "...",
+  "expires_after": ...
+}
+```
+
+If you do not want to log in and have the CLI store the secrets in the CLI cache locally, you can also provide the _access_token_ directly on the command line:
+
+```bash
+$ datasphere cache init --host <my host> --access-token <access token>
+```
+
+Alternatively, you can provide the _access_token_ through a `secrets.json` file:
+
+```bash
+$ datasphere cache init --host <my host> -secrets-file /path/to/secrets.json
+```
+
+The `secrets.json` file must at least contain a property called `access_token`:
+
+```json
+// secrets.json
+
+{
+  "access_token": "<access token>"
+}
+```
+
+### Passcodes
+
+Passcodes are used for authenticating commands sent from the CLI to your SAP Datasphere tenant. Passcodes can be provided explicitly using the `-p, --passcode` option in case the URL to retrieve a passcode is known, or implictly using an interactive session by omitting the `-p, --passcode` option.
+
+When omitting the `-p, --passcode` option the CLI prompts you to provide a passcode by navigating to the passcode authentication URL for your tenant. The URL is calculated based on the provided `-H, --host` value.
+
+```bash
+$ datasphere cache init -H https://mytenant.eu10.hcs.cloud.sap/
+✔ Do you want to retrieve a passcode from https://mytenant.authentication.eu10.hana.ondemand.com/passcode? … yes
+✔ Enter your temporary authentication code: … **********
+...
+```
+
+The displayed URL can be used for retrieving more passcodes by refreshing the page when sending multiple commands which can then be fed to the `-p, --passcode` option.
+
+You can retrieve the URL directly by running the `passcode-url` command:
+
+```bash
+$ datasphere passcode-url -H https://mytenant.eu10.hcs.cloud.sap/
+https://mytenant.authentication.eu10.hana.ondemand.com/passcode
+```
+
+## Usage
+
+You can either use the CLI from the terminal or command line, or use the module as a regular dependency in your code of your Node.js project.
+
+### From the command line
+
+#### Initialize the CLI
+
+Before you can list and run commands against your SAP Datasphere tenant you need to initialize the CLI first. When initializing the CLI a service document is downloaded from your SAP Datasphere tenant which describes the commands your tenant is able to understand. To initialize the CLI run
+
+```bash
+$ datasphere cache init -H https://mytenant.eu10.hcs.cloud.sap/ -p somepasscode
+```
+
+You can refresh the local copy of the service document by running the `cache init` command again.
+
+After you executed a command the CLI issues a warning in case the local version of the service document is outdated. In that case, run the `cache init` command again.
+
+```bash
+$ datasphere <command>
+Your local CLI cache is outdated. Run 'datasphere cache init' to update
+```
+
+#### List available commands
+
+To list available commands and required or optional options attach the `-h, --help` to the top-level `datasphere` command or any subcommand of `datasphere`:
+
+```bash
+$ datasphere -h
+Usage: datasphere [options] [command]
+
+Command-Line Interface for SAP Datasphere.
+
+Options:
+  -v, --version           output the current version
+  -H, --host <host>       specifies the urlspecifies the url host where the tenant is hosted where the tenant is hosted
+  -h, --help              display help for command
+
+Commands:
+  cache clean             clean the local CLI cache
+  cache init [options]    initialize the local CLI cache
+  passcode-url [options]  print the passcode url
+  help [command]          display help for command
+```
+
+To list commands for a tenant for which the CLI was initialized, add the `-H, --host` option (notice the additional command `spaces`):
+
+```bash
+$ datasphere -H https://mytenant.eu10.hcs.cloud.sap/ -h
+Usage: datasphere [options] [command]
+
+Command-Line Interface for SAP Datasphere.
+
+Options:
+  -v, --version           output the current version
+  -H, --host <host>       specifies the url where the tenant is hosted
+  -h, --help              display help for command
+
+Commands:
+  cache clean             clean the local CLI cache
+  cache init [options]    initialize the local CLI cache
+  spaces                  manage and orchestrate spaces
+  passcode-url [options]  print the passcode url
+  help [command]          display help for command
+```
+
+To show available subcommands for a top-level command, run eg:
+
+```bash
+$ datasphere spaces -H https://mytenant.eu10.hcs.cloud.sap/ -h
+Usage: datasphere spaces [options] [command]
+
+manage and orchestrate spaces
+
+Options:
+  -H, --host <host> specifies the url where the tenant is hosted
+  -h, --help        display help for command
+
+Commands:
+  create [options]  creates or updates space details based on an import file
+  read [options]    fetches space details for a specified space
+  delete [options]  delete an existing space
+  help [command]    display help for command
+```
+
+```bash
+$ datasphere spaces create -H https://mytenant.eu10.hcs.cloud.sap/ -h
+Usage: datasphere spaces create [options]
+
+creates or updates space details based on an import file
+
+Options:
+  -f, --filePath <filePath>  specifies the file to use as input for the command
+  -V, --verbose              print detailed log information to console (optional)
+  -H, --host <host>          specifies the url where the tenant is hosted
+  -p, --passcode <passcode>  passcode for interactive session authentication (optional)
+  -h, --help                 display help for command
+```
+
+The list of available commands differs based on the content of the service document you downloaded when running `cache init`.
+
+### As a Node.js module dependency
+
+Require the module as usual. You can also use it in your TypeScript project using the `import` syntax.
+
+```javascript
+const datasphere = require("@sap/datasphere-cli");
+```
+
+#### Work with commands
+
+The module exports a `getCommands` function which returns a map of available commands. Make sure to always specify the `host` to receive `host`-specific commands. Otherwise, when omitting the `host` information, you will only get the list of general commands like `cache clean`, `cache init`, ...
+
+```javascript
+const MY_HOST = "https://mytenant.eu10.hcs.cloud.sap/";
+
+const commands = await datasphere.getCommands(MY_HOST);
+
+console.log(commands);
+// {
+//   datasphere: [AsyncFunction],
+//   'cache clean': [AsyncFunction],
+//   'cache init': [AsyncFunction],
+//   'passcode-url': [AsyncFunction],
+//   'cache show': [AsyncFunction]
+//   'spaces create': [AsyncFunction]
+//   'spaces read': [AsyncFunction]
+//   'spaces delete': [AsyncFunction]
+// }
+```
+
+You can call any available command and provide required options as follows:
+
+```javascript
+const MY_HOST = "https://mytenant.eu10.hcs.cloud.sap/";
+
+const options = {
+  "--host": MY_HOST,
+  "--passcode": "somepasscode",
+};
+
+await commands["cache init"](options);
+```
+
+`options` is a map of available options for the respective command. You have to supply either the short flag or long name of the option, including `-` or `--` for the short flag or long name.
+
+#### Handle errors during command execution
+
+If the command fails, an error is thrown you can catch and process as usual:
+
+```javascript
+try {
+  await commands["cache show"]();
+} catch (err) {
+  // ops, the command failed!
+  console.log(err);
+}
+```
+
+#### Work with command results
+
+The result of executing a command is returned from the function call.
+
+```javascript
+const result = await commands["spaces read"]({
+  "--space": "MYSPACE",
+  "--host": "https://mytenant.eu10.hcs.cloud.sap/",
+  "--passcode": "mypasscode",
+});
+
+console.log(result);
+// [
+//   [
+//     '{\n' +
+//       '  "MYSPACE": {\n' +
+//       '    "spaceDefinition": {\n' +
+//       '      "version": "1.0.4",\n' +
+// ...
+//       '    }\n' +
+//       '  }\n' +
+//       '}'
+//   ]
+// ]
+```
+
+#### Provide custom logger function
+
+Any output of a command you execute is forwarded to the `logger.output` function. To handle the result yourself, you can provide a custom `logger.output` function implementation:
+
+```javascript
+let result = [];
+const output = (...args) => result.push(args);
+datasphere.configure({ customLogger: { output } });
+
+await commands["spaces read"]({
+  "--space": "MYSPACE",
+  "--host": "https://mytenant.eu10.hcs.cloud.sap/",
+  "--passcode": "mypasscode",
+});
+
+console.log(result);
+// [
+//   [
+//     '{\n' +
+//       '  "MYSPACE": {\n' +
+//       '    "spaceDefinition": {\n' +
+//       '      "version": "1.0.4",\n' +
+// ...
+//       '    }\n' +
+//       '  }\n' +
+//       '}'
+//   ]
+// ]
+```
+
+#### Provide custom passcode retrieval function
+
+You can also provide a custom passcode retrieval function which is called every time before a command is executed. The function is expected to return a promise resolving into a string, the passcode. This way you can, for example, make use of programmatic passcode retrieval as described in [this blog](https://blogs.sap.com/2021/09/27/automatically-add-members-to-spaces-in-sap-data-warehouse-cloud-using-sap-datasphere-cli/) using a headless browser and can omit the `--passcode` option when executing commands. The function needs to be configured only once before executing the first command.
+
+```javascript
+const logger = {
+  customLogger: { output: console.log },
+};
+
+const passcodeFunction = () => {
+  // instantiate headless browser, retrieve passcode, return it
+};
+
+datasphere.configure(logger, passcodeFunction);
+
+// no --passcode option required
+await commands["spaces read"]({
+  "--space": "MYSPACE",
+  "--host": "https://mytenant.eu10.hcs.cloud.sap/",
+});
+```
+
+### Options Handling
+
+No matter how you use the CLI ([from the command-line](#from-the-command-line) or [as a Node.js module dependency](#as-a-nodejs-module-dependency)), you can supply values for options in different ways. To get an overview of the existing options per command, run `datasphere <command> --help`:
+
+```bash
+$ datasphere cache init --help
+
+Usage: datasphere cache init [options]
+
+initialize the local CLI cache
+
+Options:
+  -V, --verbose                  print detailed log information to console (optional)
+  -O, --options-file <file>      path to options file (optional)
+  -H, --host <host>              specifies the url where the tenant is hosted (optional)
+  -p, --passcode <passcode>      passcode for interactive session authentication (optional)
+  -s, --secrets-file <file>      path to secrets file (optional)
+  -c, --client-id <id>           client id for interactive oauth session authentication (optional)
+  -C, --client-secret <secret>   client secret for interactive oauth session authentication (optional)
+  -a, --authorization-url <url>  authorization url for interactive oauth session authentication (optional)
+  -t, --token-url <url>          token url for interactive oauth session authentication (optional)
+  -A, --access-token <token>     access token for interactive oauth session authentication (optional)
+  -r, --refresh-token <token>    refresh token for interactive oauth session authentication (optional)
+  -e, --expires-in <expires>     expires in information for interactive oauth session authentication (optional)
+  -h, --help                     display help for command
+```
+
+#### On the command-line
+
+You can use the short flag or long name to supply an option value on the command-line:
+
+```bash
+$ datasphere cache init --host <host>
+```
+
+#### Using environment variables
+
+To provide an option value, the option's long name is translated to CONSTANT_CASE. For example, the option `client-id` can also be provided as follows:
+
+```bash
+$ CLIENT_ID='<my client id>' HOST='my-host' datasphere cache init
+```
+
+#### Provide options file
+
+You can provide a JSON file with a map of options, using the option's long names, and point the CLI to it using the [On the command-line](#on-the-command-line) or [Using environment variables](#using-environment-variables) way. Define the file as follows:
+
+```json
+// options-file.json
+
+{
+  "host": "my-host",
+  "client-id": "my client id"
+}
+```
+
+Then, supply it to the CLI:
+
+```bash
+$ datasphere cache init --options-file /path/to/options-file.json
+```
+
+### Environment Variables
+
+The CLI supports the following environment variables. You can set the environment variables when calling the CLI according to the local environment. In addition, the CLI supports the [`dotenv`](https://www.npmjs.com/package/dotenv#usage) module, allowing you to place a `.env` file in the CLI working directory.
+
+#### `DWC_CLI_PORT`
+
+Defines the port the CLI starts the HTTP server at when logging in when using OAuth clients for authentication.
+
+| Type   | Required | Default |
+| ------ | -------- | ------- |
+| number | no       | 8080    |
+
+## Help Documentation
+
+Find the full documentation on [help.sap.com](https://help.sap.com/docs/SAP_DATASPHERE/d0ecd6f297ac40249072a44df0549c1a/3f9a42ccde6b4b6aba121e2aab79c36d.html), check out the blog post on [blogs.sap.com](https://blogs.sap.com/2021/09/21/new-command-line-for-sap-data-warehouse-cloud-code-way-to-the-cloud/) or use option `-h, --help`:
+
+```bash
+$ datasphere <command> -h
+```
+
+## Community & Feedback
+
+SAP Community provides a forum where you can ask and answer questions, and comment and vote on the questions of others and their answers.
+
+See [SAP Datasphere community](https://community.sap.com/topics/data-warehouse-cloud) for more details and use the tag _datasphere-cli_ for questions concerning the CLI.
+
+## License
+
+This package is provided under the terms of the [SAP Freeware License Agreement](https://tools.hana.ondemand.com/sap-freeware-license.txt).

package/module.d.ts

@@ -0,0 +1 @@
+export { configure, getCommands } from "@sap/cli-core";

package/module.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommands = exports.configure = void 0;
+if (process.env.SUPPRESS_NO_CONFIG_WARNING === undefined) {
+    process.env.SUPPRESS_NO_CONFIG_WARNING = "true";
+}
+// eslint-disable-next-line import/first
+const utils_1 = require("./utils");
+(0, utils_1.configure)();
+var cli_core_1 = require("@sap/cli-core");
+Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return cli_core_1.configure; } });
+Object.defineProperty(exports, "getCommands", { enumerable: true, get: function () { return cli_core_1.getCommands; } });

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@sap/datasphere-cli",
+  "version": "2023.14.0",
+  "description": "Command-Line Interface for SAP Datasphere.",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "SAP SE",
+  "homepage": "https://www.sap.com",
+  "main": "module.js",
+  "bin": {
+    "datasphere": "terminal.js"
+  },
+  "engines": {
+    "node": "^16",
+    "npm": "^8"
+  },
+  "keywords": [
+    "cli",
+    "sap datasphere",
+    "datasphere-cli"
+  ],
+  "dependencies": {
+    "@sap/cli-core": "2023.13.0"
+  }
+}

package/terminal.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/terminal.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+"use strict";
+/* eslint-disable import/first */
+Object.defineProperty(exports, "__esModule", { value: true });
+if (process.env.SUPPRESS_NO_CONFIG_WARNING === undefined) {
+    process.env.SUPPRESS_NO_CONFIG_WARNING = "true";
+}
+const cli_core_1 = require("@sap/cli-core");
+const utils_1 = require("./utils");
+(0, utils_1.configure)();
+void (async () => {
+    (0, utils_1.configure)();
+    void (0, cli_core_1.run)();
+})();

package/utils.d.ts

@@ -0,0 +1 @@
+export declare const configure: () => void;

package/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configure = void 0;
+const cli_core_1 = require("@sap/cli-core");
+const configure = () => {
+    (0, cli_core_1.configureCoreModule)({
+        name: (0, cli_core_1.getBin)(__dirname),
+        packageName: (0, cli_core_1.getPackageName)(__dirname),
+        discoveryPath: "/dwaas-core/api/v1/discovery",
+        description: (0, cli_core_1.getDescription)(__dirname),
+        sapHelpLink: "tinyurl.com/datasphere-cli-help",
+        version: (0, cli_core_1.getVersion)(__dirname),
+        authenticationMethods: [
+            cli_core_1.AuthenticationMethod.oauth,
+            cli_core_1.AuthenticationMethod.passcode,
+        ],
+    });
+};
+exports.configure = configure;