doc

Author: clun

astra-shell/README.MD

@@ -4,154 +4,76 @@
 
 ## Overview
 
-Astra Shell is a standalone command line interface. 
+_This component is in heavy development that can lead to breaking changes_
 
-- (1). It can be used as a stateless cli providing all options in the command line for automation purposes.
+## Installation
 
-```
-astra create db 
- --token AstraCS:...... \ 
- --name workshop \
- --region eu-central-1 \
- --keyspace nosql1
-```
+Installing ASTRA-CLI on UNIX-like platforms is as easy as ever. ASTRA-CLI installs smoothly on macOS, Linux, WSL, Cygwin, Solaris and FreeBSD. We also support Bash and ZSH shells.
 
-- (2). It provides a configuration file to avoid users to enter credentials (tokens) each time.
+- Open a new terminal and enter:
 
 ```
-astra create db 
- --config my_env_dev \ 
- --name workshop \
- --region eu-central-1 \
- --keyspace nosql1
-```
-
-- (3). It provides a shell, an interactive repl with users interactions.
-
-```
-astra --config my_env_dev
-
-$myAstraOrganization>create db  --name workshop --region eu-central-1 --keyspace nosql1
+curl -Ls curl -s "https://dtsx.io/get-astra-cli" | bash
 ```
 
-## Prequisites
+- Follow the instructions on-screen to complete installation. Next, open a new terminal or enter:
 
-- A JRE/JDK 8+ installed is required.
+$ source "$HOME/.astra/install/astra-init.sh"
 
-## Installations
-
-- Download and extract the zip archive
+- Lastly, run the following code snippet to ensure that installation succeeded:
 
 ```
-unzip astra-shell-alpha1.zip
+astra -v
 ```
 
-- Initialization 
+If all went well, the version should be displayed. Something like:
 
 ```
-cd astra-shell
-chmod 700 astra
-source auto-completions.bash
+0.3.2-SNAPSHOT
 ```
 
-- Configuration
-
+## Setup
 
-You are already set and can start typing commands
-
-```
-astra show dbs -t <TOKEN>
-```
-
-But it is annoying each time having to provide a token. What if you could save it ?
+- Run the following command and provide your token when needed
 
 ```
 astra setup
 ```
 
-- You can now 
-
-```
-astra show dbs
-```
-
-## Configuration file
-
-- List available configurations
+- You should be good to go
 
 ```
-astra show configs
 astra config list
 ```
 
-- Create a new configuration providing a name
-
-```
-astra config create dev -t <TOKEN>
-astra config list
+>```
++-----------------------------------------+
+| configuration                           |
++-----------------------------------------+
+| default ([email protected])   |
+| DatastaxDevs                            |
+| [email protected]             |
++-----------------------------------------+
 ```
 
-- Show details of a dev
+- And access Astra
 
 ```
-astra config show dev
+astra db list
 ```
 
-- Set a configuration as default
-
-```
-astra config default my_new_section
+>```
++---------------------+--------------------------------------+---------------------+----------------+
+| name                | id                                   | default-region      | status         |
++---------------------+--------------------------------------+---------------------+----------------+
+| mtg                 | dde308f5-a8b0-474d-afd6-81e5689e3e25 | eu-central-1        | ACTIVE         |
+| workshops           | 3ed83de7-d97f-4fb6-bf9f-82e9f7eafa23 | eu-west-1           | ACTIVE         |
+| sdk_tests           | 06a9675a-ca62-4cd0-9b94-aefaf395922b | us-east-1           | ACTIVE         |
+| api_days_dubai_2022 | 53f07b2a-8856-4741-b595-72b03be56bc6 | us-east1            | ACTIVE         |
+| free_db             | 8642763c-8ba7-4ede-a031-82355c7c34a7 | us-east1            | ACTIVE         |
++---------------------+--------------------------------------+---------------------+----------------+
 ```
 
-- Rename on organization
 
-```
-astra config rename my_new_section --name section2
-```
 
-- Delete a configuration
-
-```
-astra config delete dev
-astra config list
-```
-
-## Let's start the SHOW
-
-```
-astra show dbs
-```
-
-```
-astra show roles
-```
-
-```
-astra show role <ROLE>
-```
-
-```
-astra show users
-```
-
-```
-astra show user <USER>
-```
-
-## Shell we started now ?
-
-
-```
-astra shell
-```
-
-
-## Configuration
-
-```
-show config <CONFIG>
-config load --name <CONFIG>
-config save --name <CONFIG>
-config setdefault --name <XXX>
-```
 

astra-shell/src/main/java/com/datastax/astra/shell/AstraCli.java

@@ -11,7 +11,7 @@
 import com.datastax.astra.shell.cmd.config.Setup;
 import com.datastax.astra.shell.cmd.db.Db;
 import com.datastax.astra.shell.cmd.db.DbCreateCli;
-import com.datastax.astra.shell.cmd.db.DbDelete;
+import com.datastax.astra.shell.cmd.db.DbDeleteCli;
 import com.datastax.astra.shell.cmd.db.DbListCli;
 import com.datastax.astra.shell.cmd.shell.ShellCommand;
 import com.datastax.astra.shell.utils.LoggerShell;
@@ -36,6 +36,7 @@
   groups = {
           @Group(name = Db.DB, description = "Commands acting of database", commands = { 
                   DbCreateCli.class,
+                  DbDeleteCli.class,
                   DbListCli.class
           }),
           @Group(name = "config", description = "Edit configuration file", commands = { 

astra-shell/src/main/java/com/datastax/astra/shell/AstraShell.java

@@ -3,15 +3,13 @@
 import com.datastax.astra.shell.cmd.ExitCommand;
 import com.datastax.astra.shell.cmd.HelpCommand;
 import com.datastax.astra.shell.cmd.QuitCommand;
+import com.datastax.astra.shell.cmd.db.Db;
+import com.datastax.astra.shell.cmd.db.DbCreateShell;
+import com.datastax.astra.shell.cmd.db.DbDeleteShell;
 import com.datastax.astra.shell.cmd.db.DbListShell;
-import com.datastax.astra.shell.cmd.iam.ShowRoleCommand;
-import com.datastax.astra.shell.cmd.iam.ShowRolesCommand;
-import com.datastax.astra.shell.cmd.iam.ShowUserCommand;
-import com.datastax.astra.shell.cmd.iam.ShowUsersCommands;
 import com.datastax.astra.shell.cmd.shell.ConnectCommand;
 import com.datastax.astra.shell.cmd.shell.CqlShCommand;
 import com.datastax.astra.shell.cmd.shell.EmptyCommand;
-import com.datastax.astra.shell.cmd.show.ShowConfigsCommand;
 import com.datastax.astra.shell.cmd.use.UseDb;
 import com.datastax.astra.shell.utils.LoggerShell;
 import com.github.rvesse.airline.annotations.Cli;
@@ -37,20 +35,16 @@
     CqlShCommand.class
 },
   groups = {
-          @Group(
-              name = "show",
-              description = "Listing details of an entity or entity list",
-              commands = { 
-                      DbListShell.class,
-                      ShowRoleCommand.class, ShowRolesCommand.class, 
-                      ShowUserCommand.class, ShowUsersCommands.class,
-                      ShowConfigsCommand.class }
-          ),
+          @Group(name = Db.DB, description = "Commands acting of database", commands = { 
+                  DbCreateShell.class,
+                  DbDeleteShell.class,
+                  DbListShell.class
+          }),
           @Group(
                name = "use",
                description = "Focus on an entity (context & prompt changed)",
                commands = {
-                      UseDb.class
+                   UseDb.class
                }
           )
     })

astra-shell/src/main/java/com/datastax/astra/shell/cmd/HelpCommand.java

@@ -17,15 +17,5 @@ public class HelpCommand<T> extends Help<T> {
     @Override
     public void run() {
         super.run();
-        /*
-        try {
-            if (!command.isEmpty()) {
-                new CliGlobalUsageSummaryGenerator<T>(false)
-                    .usage(global, System.out);
-                return;
-            }
-        } catch (IOException e) {
-            throw new RuntimeException("Error generating usage documentation", e);
-        }*/
     }
 }