@gooddata/code-cli 0.1.0

package/README.md

@@ -0,0 +1,83 @@
+<p align="center">
+  <img src="assets/gooddata-logo.svg" alt="GoodData Logo" width="120px" height="120px"/>
+</p>
+<h1 align="center">GoodData CLI</h1>
+
+> GoodData for VS Code and GoodData CLI are available for you to try out and provide feedback. Avoid using those in a production environment.
+
+Manage your analytics as code. The solution consists of two components:
+
+* [GoodData Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=GoodData.gooddata-vscode).
+* [GoodData Command-line Interface](https://www.npmjs.com/package/@gooddata/code-cli).
+
+Together these tools allow you to:
+
+1. Retrieve analytical objects from a GoodData server.
+1. Create or update analytical objects in Visual Studio Code.
+1. Test analytical objects locally in Visual Studio Code.
+1. Deploy analytical objects to a GoodData server of your choice.
+
+The analytical objects you can work with include datasets, which form the logical data model, and metrics. Additionally, we have plans to incorporate support for visualizations in the near future.
+
+With GoodData CLI you can:
+
+* Initialize a new project.
+* Clone existing analytical project from GoodData server.
+* Validate the analytical project, for example, in CI pipelines.
+* Deploy the analytical project to GoodData server.
+
+## Prerequisites
+
+Before getting started, ensure that you have:
+
+* A running instance of GoodData. Ensure you have the following information on hand:
+    * [API access token](https://www.gooddata.com/developers/cloud-native/doc/cloud/manage-organization/user-token/).
+    * Workspace ID of a workspace you want to clone and edit.
+    * Data source ID of the data source the workspace is connected to
+* [Node.js version 16.17 or newer installed](https://nodejs.org/).
+
+## Install CLI
+
+In terminal, run `npm i -g @gooddata/code-cli`.
+You should have a new CLI command available, try running `gd -v` or `gd --help`.
+
+## `gd init` command
+
+Once the CLI is installed you are able to initialize your project locally.
+
+**Steps:**
+
+1. Open a terminal and navigate to a folder where you want to build and store your analytics.
+1. To initialize your project, run `gd init` and follow the instructions to create a `gooddata.yaml` definition file.
+1. Create a `.env` file in the same folder as `gooddata.yaml` and add an environmental variable that stores
+   your API access token. For example:`GD_API_TOKEN="fd6f9a71541856b4c9617f74a8576e131"`.
+
+> Make sure you do not store the `.env` file in you version control system (like Git).
+> For example, you can add the file to `.gitignore`.
+
+## `gd clone` command
+
+To clone your GoodData analytical environment to your local machine, run `gd clone`.
+
+You should now have an `analytics` folder that contains your `datasets` and `metrics`.
+
+## `gd validate` command
+
+GoodData CLI can run validation on your project. This is useful if you want to set up CI/CD pipelines
+and, for example, ensure the project is valid before merging a pull request.
+
+GoodData CLI will validate that:
+* syntax of the YAML files is correct;
+* there are no missing or unsupported properties;
+* references between dataset and metrics are valid; and
+* references to the database tables and columns are valid.
+
+To execute validation, run `gd validate`.
+
+## `gd deploy` command
+
+GoodData CLI can deploy your analytical project to the GoodData server defined in `gooddata.yaml` file.
+
+To execute the deployment, run `gd deploy`.
+
+Before deploying the project, GoodData CLI will also run validation, unless `--no-validate` argument was passed to the command.

package/assets/gooddata-logo.svg

@@ -0,0 +1,4 @@
+<svg width="120" height="120" viewBox="0 0 120 120" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="120" height="120" rx="60" fill="#ED27B7"/>
+<path d="M92.3439 70.0835C92.1111 60.1453 86.6249 52.2567 78.2492 49.1733V31.8762C76.1342 30.5243 73.8835 29.4066 71.5341 28.5473V65.7597C71.5341 73.1314 68.1143 76.4231 62.6183 76.4231C57.2679 76.4231 52.7923 72.3819 52.7923 65.624C52.7923 58.0811 58.6714 53.4746 66.3696 53.4746C67.0827 53.4616 67.8087 53.4988 68.5218 53.6102V47.0251C67.8087 46.9023 67.0956 46.841 66.3696 46.8539C54.9444 46.8539 45.9915 53.8573 45.9915 65.6385C45.9915 76.9658 54.0713 83.0099 63.0743 83.0099C67.3414 83.0099 71.0312 81.5594 73.5779 79.0656C76.1229 76.5717 78.2767 72.9715 78.2767 66.6448V56.3367C82.9253 58.6593 85.7291 64.285 85.742 70.7231C85.7178 82.8484 74.464 93.0951 61.2682 93.0951C60.961 93.0951 60.7265 93.0951 60.4193 93.0822C51.3678 93.0709 43.4109 89.8017 36.9658 83.3523C32.3284 78.7086 29.156 72.7987 27.877 66.3734C26.5981 59.9353 27.2497 53.2775 29.7705 47.2076C32.2799 41.1507 36.5341 35.9659 41.9944 32.3172C47.4548 28.6685 53.8756 26.727 60.442 26.727V19.9707C55.1902 19.9707 49.9885 21.0028 45.1426 23.0056C40.2967 25.0085 35.8825 27.9562 32.1684 31.655C24.6658 39.1365 20.4473 49.296 20.4473 59.8868C20.4473 70.476 24.6529 80.6372 32.1425 88.1316C39.6321 95.6261 49.8026 99.8401 60.4048 99.8401H61.2537C64.5134 99.8401 67.7602 99.3362 70.8841 98.3655C70.897 98.3655 70.9083 98.3526 70.9213 98.3526C75.4341 96.9522 79.567 94.5682 83.0353 91.375C89.0244 85.8462 92.3213 78.5374 92.3456 70.7603C92.3569 70.7345 92.3439 70.0964 92.3439 70.0835Z" fill="white"/>
+</svg>

package/bin/gd

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("../out/index.js");

package/out/index.d.ts

@@ -0,0 +1 @@
+export { }