chore: #754 - add help information into root commands (#844)

janhq · Jul 5, 2024 · 27506e4 · 27506e4
1 parent 20ecd54
commit 27506e4
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/cortex-cpp/README.md b/cortex-cpp/README.md
@@ -163,7 +163,7 @@ Below is the available list of the model parameters you can set when loading a m
 
 
 ## Manual Build
-Manual build is a process in which the developers build the software manually. This is usually done when a new feature is implemented, or a bug is fixed. The process for this project is defined in [`.github/workflows/build.yml`](.github/workflows/build.yml)
+Manual build is a process in which the developers build the software manually. This is usually done when a new feature is implemented, or a bug is fixed. The process for this project is defined in [`.github/workflows/cortex-build.yml`](../.github/workflows/cortex-build.yml)
 
 ## Contact Support
 

diff --git a/cortex-js/src/infrastructure/commanders/configs.command.ts b/cortex-js/src/infrastructure/commanders/configs.command.ts
@@ -8,17 +8,15 @@ import { ConfigsSetCommand } from './configs/configs-set.command';
 @SubCommand({
   name: 'configs',
   description: 'Get cortex configurations',
-  arguments: '<name>',
   subCommands: [ConfigsGetCommand, ConfigsListCommand, ConfigsSetCommand],
-  argsDescription: {
-    name: 'Configuration name to get',
-  },
 })
 @SetCommandContext()
 export class ConfigsCommand extends CommandRunner {
   constructor(readonly contextService: ContextService) {
     super();
   }
 
-  async run(): Promise<void> {}
+  async run(): Promise<void> {
+    this.command?.help();
+  }
 }
diff --git a/cortex-js/src/infrastructure/commanders/engines.command.ts b/cortex-js/src/infrastructure/commanders/engines.command.ts
@@ -16,5 +16,7 @@ export class EnginesCommand extends CommandRunner {
     super();
   }
 
-  async run(): Promise<void> {}
+  async run(): Promise<void> {
+    this.command?.help();
+  }
 }
diff --git a/cortex-js/src/infrastructure/commanders/models.command.ts b/cortex-js/src/infrastructure/commanders/models.command.ts
@@ -23,5 +23,7 @@ import { RunCommand } from './shortcuts/run.command';
   description: 'Subcommands for managing models',
 })
 export class ModelsCommand extends CommandRunner {
-  async run(): Promise<void> {}
+  async run(): Promise<void> {
+    this.command?.help();
+  }
 }
diff --git a/cortex-js/src/infrastructure/commanders/models/model-list.command.ts b/cortex-js/src/infrastructure/commanders/models/model-list.command.ts
@@ -22,6 +22,7 @@ export class ModelListCommand extends CommandRunner {
       ? console.table(
           models.map((e) => ({
             id: e.model,
+            name: e.name,
             engine: e.engine,
             version: e.version,
           })),