@gooddata/code-cli 0.1.0 → 0.2.0

package/README.md

@@ -1,9 +1,9 @@
 <p align="center">
-  <img src="assets/gooddata-logo.svg" alt="GoodData Logo" width="120px" height="120px"/>
+  <img src="https://raw.githubusercontent.com/gooddata/gooddata-ui-sdk/master/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.
+> GoodData for VS Code and GoodData CLI are available for you to try out and provide feedback. Avoid using them in a production environment.
 
 Manage your analytics as code. The solution consists of two components:
 
@@ -14,26 +14,24 @@ 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.
+1. Preview analytical objects in Visual Studio Code.
+1. Deploy analytical objects to a workspace.
 
 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.
+* Initialize a new local environment.
+* Clone an existing workspace.
+* Validate local analytical objects.
+* Deploy your analytical objects to a workspace.
 
 ## 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
+* GoodData [workspace](https://www.gooddata.com/developers/cloud-native/doc/cloud/create-workspaces/concepts/workspace/).
+* [API access token](https://www.gooddata.com/developers/cloud-native/doc/cloud/manage-organization/user-token/).
 * [Node.js version 16.17 or newer installed](https://nodejs.org/).
 
 ## Install CLI
@@ -43,41 +41,39 @@ 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.
+Once the CLI is installed you are able to initialize your local environment.
 
 **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"`.
+1. To initialize your local environment, run `gd init` and follow the instructions to create a `gooddata.yaml` configuration file.
+
+> The gd_init step also creates `.env` and  `.gitignore` files, in case you wish to store the analytics in a Version Control System (like Git)
 
-> 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`.
+To clone existing workspace to your local environment, run `gd clone`.
 
-You should now have an `analytics` folder that contains your `datasets` and `metrics`.
+You should now have an `analytics` folder that contains your analytical objects.
 
 ## `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 validate your local environment. This is useful if you want to set up CI/CD pipelines
+and, for example, ensure the workspace 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.
+GoodData CLI validates:
+* syntax of the YAML files is correct.
+* properties (e.g. there can' be any missing or invalid).
+* references between analytical objects.
+* references to the database tables and columns.
 
 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.
+GoodData CLI can deploy your local environment to a workspace 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.
+Before deploying, GoodData CLI will also run validation, unless `--no-validate` argument was passed to the command.