✨ commander cli for creating or destroying a database

commander cli for creating or destroying a database

✨ New feature

Author: TimMikeladze

README.md

@@ -32,30 +32,41 @@ Save this token somewhere safe, you will need it to authenticate with the Gist A
 
 Now let's create a new database. The empty database will be created as single gist containing a single file called `database.json` with an empty JSON object: `{}`.
 
-This package comes with a cli command to help you get started.
-
-In your terminal run the following command:
+This package comes with a cli tool to help you perform common database operations.
 
 ```console
-GIST_TOKEN="xxxxxxxx" node node_modules/gist-database/dist/cli.modern.js
+Usage: gist-database [options]
+
+Transform gist into a key/value datastore.
 
-# or for a public gist
-GIST_TOKEN="xxxxxxxx" node node_modules/gist-database/dist/cli.modern.js public
+Options:
+  -c --create                      Create a new gist database.
+  -p --public                      Make the gist public. (default: false)
+  -de --description <description>  Description of the gist. (default: "")
+  -des --destroy <destroy>         Destroy a gist database. Provide the gist id of the database.
+  -t --token <token>               Gist token. Required for all operations.
+  -h, --help                       display help for command
+```
 
-# or for a public gist with a description
-GIST_TOKEN="xxxxxxxx" node node_modules/gist-database/dist/cli.modern.js public "My awesome database"
+To create a new database run the following command in your terminal:
+
+```console
+npx gist-database create --token <your-token>
 ```
 
 If successful, you should see output similar to:
 
 ```json
 {
-  "id": "xxxxxxxxxxxxxxxxxxx",
-  "url": "https://api.github.com/gists/xxxxxxxxxxx"
+  "id": "xxxxxxxxxxxx",
+  "rawUrl": "https://api.github.com/gists/xxxxxxxxxxxx",
+  "url": "https://gist.github.com/xxxxxxxxxxxx",
+  "public": false,
+  "description": ""
 }
 ```
 
-This is the gist containing your main database file. Save the `id` somewhere safe. You will need it to initialize the database.
+This is the gist containing your main database file. Save the `id` somewhere safe. You will need it to initialize your database instance.
 
 ## 📖 API
 

package.json

@@ -90,6 +90,7 @@
   },
   "dependencies": {
     "buffer": "6.0.3",
+    "commander": "9.4.1",
     "cross-fetch": "3.1.5",
     "cryptr": "6.1.0",
     "is-plain-obj": "4.1.0",

src/cli.ts

@@ -1,32 +1,66 @@
 #!/usr/bin/env node
 
 import { GistDatabase } from './GistDatabase'
+import { program } from 'commander'
 
-if (!process.env.GIST_TOKEN) {
-  console.error('GIST_TOKEN is required')
-  process.exit(1)
+interface CommanderOptions {
+  create: boolean
+  description: string
+  destroy: string
+  public: boolean
+  token: string
 }
 
 const main = async () => {
-  console.log('Creating database...')
+  program
+    .name('gist-database')
+    .description('Transform gist into a key/value datastore.')
+    .option('-c --create', 'Create a new gist database.')
+    .option('-p --public', 'Make the gist public.', false)
+    .option('-de --description <description>', 'Description of the gist.', '')
+    .option(
+      '-des --destroy <destroy>',
+      'Destroy a gist database. Provide the gist id of the database.'
+    )
+    .requiredOption(
+      '-t --token <token>',
+      'Gist token. Required for all operations.'
+    )
+  try {
+    program.parse(process.argv)
 
-  const isPublic = process.argv[2] === 'public'
+    const options: CommanderOptions = program.opts()
 
-  const res = await GistDatabase.createDatabaseRoot({
-    token: process.env.GIST_TOKEN,
-    public: isPublic,
-    description: process.argv[3]
-  })
+    if (options.create) {
+      console.log('Creating database...')
+      const res = await GistDatabase.createDatabaseRoot({
+        token: options.token,
+        public: options.public,
+        description: options.description
+      })
+      console.log('Database created!')
+      console.log({
+        id: res.id,
+        rawUrl: res.url,
+        url: `https://gist.github.com/${res.id}`,
+        public: options.public,
+        description: options.description
+      })
+    } else if (options.destroy) {
+      console.log('Destroying database...')
+      const db = new GistDatabase({
+        token: options.token,
+        id: options.destroy
+      })
+      await db.destroy()
+      console.log('Database destroyed!')
+    }
+  } catch (err) {
+    console.error(err)
+    process.exit(1)
+  }
 
-  console.log('Database created')
-
-  console.log({
-    id: res.id,
-    rawUrl: res.url,
-    url: `https://gist.github.com/${res.id}`,
-    public: isPublic,
-    description: process.argv[3]
-  })
+  process.exit()
 }
 
 main()