[fix] improved the docs of the baselime rehydrate command

Author: boristane

CHANGELOG.md

@@ -10,6 +10,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 - Added baselime mark command
 
+## Changed
+- Improved the docs of the baselime rehydrate command
+
 ### Removed
 - Removed unnecessary options in baselime console command
 

src/commands/rehydrate.ts

@@ -6,32 +6,25 @@ import api from "../services/api/api";
 import { promptSelectAccount } from "./rehydrate/prompts";
 
 export interface Options extends BaseOptions {
-  config?: string;
-  startDate?: string;
-  hoursToRecover?: number;
+  "start-date"?: string;
+  "hours-to-recover"?: number;
 }
 
 export const command = "rehydrate";
-export const desc = "Rehydrate expired data from your s3";
+export const desc = "Rehydrate Baselime hot storage with data from your Amazon S3 Bucket";
 
 export const builder: CommandBuilder<Options, Options> = (yargs) => {
   return yargs
     .options({
       ...baseOptions,
-      config: {
-        type: "string",
-        desc: "The configuration folder to execute",
-        alias: "c",
-        default: ".baselime",
-      },
-      startDate: { type: "string", desc: "Date onwards which to recover the data ISO format" },
-      hoursToRecover: { type: "number", desc: "Consecutive hours of data from startDate to recover" },
+      "start-date": { type: "string", desc: "Date to start recovering data from, in ISO format" },
+      "hours-to-recover": { type: "number", desc: "Number of consecutive hours of data to recover starting from start-date. Minimum: 1, maximum: 12", },
     })
     .example([
       [
         `
-      $0 rehydrate --startDate 2023-06-08T13:24:47.906Z --hoursToRecover 1
-      $0 rehydrate --config .baselime --profile prod --startDate 2023-06-08T13:24:47.906Z --hoursToRecover 1`,
+      $0 rehydrate --start-date 2023-06-08T13:24:47.906Z --hours-to-recover 1
+      $0 rehydrate --profile prod --start-date 2023-06-08T13:24:47.906Z --hours-to-recover 9`,
       ],
     ])
     .fail((message, err, yargs) => {
@@ -40,25 +33,26 @@ export const builder: CommandBuilder<Options, Options> = (yargs) => {
 };
 
 export async function handler(argv: Arguments<Options>) {
-  const { config, profile, startDate, hoursToRecover } = argv;
+  const { profile, "start-date": startDate, "hours-to-recover": hoursToRecover } = argv;
   spinner.init(!!argv.quiet);
   await authenticate(profile);
   const sd = new Date(startDate as string);
   if (isNaN(sd.valueOf())) {
-    throw new Error("Invalid Date");
+    throw new Error("Invalid Start date");
   }
   const htr = Number(hoursToRecover);
   if (isNaN(htr) || htr < 1 || htr > 12) {
-    throw new Error("Invalid hoursToRecover");
+    throw new Error("Invalid number of hours to recover");
   }
   const account = await promptSelectAccount();
   const s = spinner.get();
-  s.start("Requesting rehydration");
-  const result = await api.rehydrate({
+  s.start("Requesting data rehydration");
+  
+  await api.rehydrate({
     startDate: sd,
     hoursToRecover: htr,
     accountId: account.id,
     region: account.region,
   });
-  s.succeed();
+  s.succeed("Rehydration started");
 }