@docbox-nz/docbox-cli 0.2.1 → 0.3.0

package/README.md

@@ -2,98 +2,22 @@
 
 CLI tool to setup and manage document box instances
 
-# Create credentials file
+## Create credentials file
 
-The credentials file is used by the CLI to access the database with a higher level of permissions to perform things like migrations and setting up tenants. You will need this to perform a majority of the CLI actions:
+The CLI tool require a configuration file in order to operate. See the [CLI Config](https://docbox-nz.pages.dev/docs/guides/setup/cli-config) guide to set one up
 
+## Initialize root database
 
-Create a file name `cli-credentials.json` in the root of the repository:
+Before you can setup docbox tenants you must setup the root docbox database. See the [Create Root](https://docbox-nz.pages.dev/docs/guides/setup/create-root) guide to set this up
 
-```json
-{
-    "database": {
-        "__description": "Database details and credentials",
-        "host": "{DATABASE HOST}",
-        "port": 5432, // DATABASE PORT
-        "root_secret_name": "{ROOT DATABASE SECRET NAME}",
-        "root_role_name": "{ROOT DATABASE ROLE NAME}",
-        "root_secret_password": "{ROOT DATABASE SECRET PASSWORD}",
-        "setup_user": {
-            "__description": "User to use when migrating and setting up database, should have higher permissions",
-            "username": "{DB USER}",
-            "password": "{DB PASSWORD}"
-        }
-    },
-    "secrets": {
-        "__description": "Secrets manager configurations",
-        "provider": "aws"
-    },
-    "search": {
-        "__description": "Search index factory configuration",
-        "provider": "typesense",
-        "url": "http://localhost:8108",
-        "api_key": "typesensedev"
-    },
-    "storage": {
-        "provider": "s3",
-        "endpoint": {
-            "type": "aws"
-        }
-    }
-}
-```
+## Create new tenant
 
-# Initialize root database
-
-To initialize the root database for docbox run the following command
-
-```sh
-cargo run --release -p docbox-cli -- create-root
-```
-
-# Create new tenant
-
-Create a new file in this case `demo-tenant.json` this will contain the following:
-
-```json
-{
-    "id": "00000000-0000-0000-0000-000000000000",
-    "env": "{Development/Production}",
-    "db_name": "docbox-{tag}-{dev/prod}",
-    "db_secret_name": "postgres/docbox/{dev/prod}/{tag}",
-    "db_role_name": "{TENANT DB ROLE NAME}",
-    "storage_bucket_name": "docbox-{tag}-{dev/prod}",
-    "search_index_name": "docbox-{tag}-{dev/prod}",
-    "storage_s3_queue_arn": "arn:aws:sqs:ap-southeast-2:{YOUR_S3_UPLOADS_QUEUE_ARN}",
-    "event_queue_url": "https://sqs.ap-southeast-2.amazonaws.com/{YOUR_EVENT_QUEUE_ARN}",
-    "storage_cors_origins": [
-        "https://{SOME_ORIGIN}"
-    ]
-}
-```
-
-Then run the following command from the root of this repository:
-
-> You must ensure you have a `.env` file setup containing all the required environment 
-> variables from the terraform setup
->
-> Along with:
-> ```
-> AWS_ACCESS_KEY_ID={YOUR AWS KEY ID}
-> AWS_SECRET_ACCESS_KEY={YOUR AWS SECRET ACCESS KEY}
-> ```
->
-> The specified key must have high enough permission to manage S3 buckets
-
-
-```sh
-cargo run --release -p docbox-cli -- create-tenant --file ./demo-tenant.json
-```
+To create a new tenant with the CLI follow the [Create Tenant](https://docbox-nz.pages.dev/docs/guides/setup/create-tenant) guide.
 
 # Migrations
 
-To be documented, but runs a SQL migration over the database (With optional filtering for environment or tenant) 
+To be documented, but runs pending tenant migrations (With optional filtering for environment or tenant) 
 
 ```sh
- cargo run --release -p docbox-cli -- migrate --env Development --file ./packages/docbox-cli/migrations/m1_file_parent_id.sql --tenant-id 00000000-0000-0000-0000-000000000000
+docbox-cli -- migrate --env Development --tenant-id 00000000-0000-0000-0000-000000000000
 ```

package/npm-shrinkwrap.json

@@ -23,7 +23,7 @@
       "hasInstallScript": true,
       "license": "MIT",
       "name": "@docbox-nz/docbox-cli",
-      "version": "0.2.1"
+      "version": "0.3.0"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -896,5 +896,5 @@
     }
   },
   "requires": true,
-  "version": "0.2.1"
+  "version": "0.3.0"
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "artifactDownloadUrl": "https://github.com/docbox-nz/docbox-cli/releases/download/0.2.1",
+  "artifactDownloadUrl": "https://github.com/docbox-nz/docbox-cli/releases/download/0.3.0",
   "author": "Jacobtread <jacobtread@gmail.com>",
   "bin": {
     "docbox-cli": "run-docbox-cli.js"
@@ -96,7 +96,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.2.1",
+  "version": "0.3.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"