feat: Updated help for all commands

Author: kevinwang5658

src/commands/apply.ts

@@ -1,22 +1,37 @@
 import { Flags } from '@oclif/core'
+import chalk from 'chalk';
 
 import { BaseCommand } from '../common/base-command.js';
 import { ApplyOrchestrator } from '../orchestrators/apply.js';
 
 export default class Apply extends BaseCommand {
-  static description = 'Apply a codify file onto the system. A plan of the changes is first generated and a list of changes will be shown before proceeding'
+  static description =
+`Install or update resources on the system based on a codify.json file.
+
+Codify first generates a plan to determine the necessary execution steps. See
+${chalk.bold.bgMagenta(' codify plan --help ')} for more details.
+The execution plan will be presented and approval will be asked before Codify applies
+any changes.
+
+For scripts: use ${chalk.bold.bgMagenta(' --output json ')} which will skip approval and 
+apply changes directly.
+
+For more information, visit: https://docs.codifycli.com/commands/apply
+`
 
   static flags = {
     'sudoPassword': Flags.string({
       optional: true,
-      description: 'Pre-fill the sudo password to automatically use for any commands that require elevated permissions.',
+      description: 'Automatically use this password for any commands that require elevated permissions.',
       char: 'S'
     }),
   }
 
   static examples = [
     '<%= config.bin %> <%= command.id %>',
     '<%= config.bin %> <%= command.id %> --path ~',
+    '<%= config.bin %> <%= command.id %> -o json',
+    '<%= config.bin %> <%= command.id %> -S <sudo password>',
   ]
 
   async init(): Promise<void> {

src/commands/destroy.ts

@@ -1,19 +1,35 @@
 import { Flags } from '@oclif/core';
+import chalk from 'chalk';
 
 import { BaseCommand } from '../common/base-command.js';
 import { DestroyOrchestrator } from '../orchestrators/destroy.js';
 
 export default class Destroy extends BaseCommand {
   static strict = false;
-  static description = 'Destroy or uninstall a resource (or many resources).'
+  static description =
+`Use Codify to uninstall a supported package or setting on the system.
+
+This command will only work for resources with Codify support. This command
+can work with or without a codify.json file. 
+
+${chalk.bold('Modes:')}
+ • If a codify.json file exists, destroy the resource specified in the Codify.json file
+with a matching type. 
+ • If a codify.json file doesn't exist, additional information may be asked to identify
+the specific resource to destroy.
+
+For more information, visit: https://docs.codifycli.com/commands/destory`
+
   static examples = [
     '<%= config.bin %> <%= command.id %> homebrew nvm',
+    '<%= config.bin %> <%= command.id %> homebrew nvm --path=~',
+    '<%= config.bin %> <%= command.id %>',
   ]
 
   static flags = {
     'sudoPassword': Flags.string({
       optional: true,
-      description: 'Pre-fill the sudo password to automatically use for any commands that require elevated permissions.',
+      description: 'Automatically use this password for any commands that require elevated permissions.',
       char: 'S',
       helpValue: '<password>'
     }),

src/commands/import.ts

@@ -1,3 +1,4 @@
+import chalk from 'chalk';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
@@ -8,24 +9,34 @@ import { ShellUtils } from '../utils/shell.js';
 export default class Import extends BaseCommand {
   static strict = false;
   static override description =
-`Generate codify configs from already installed packages. Use a list of space separated arguments to specify the resource types to import. Leave blank to import all resource in an existing *.codify.json file.
+`Generate Codify configurations from already installed packages. Use a space-separated list of 
+arguments to specify the resource types to import. If a codify.json file already
+exists, omit arguments to update the file to match the system.
 
-Modes:
-1. No args: if no args are specified and an *.codify.json already exists. Then codify will update the existing file with any new changes to the resources specified in the file/files.
+${chalk.bold('Modes:')}
+1. ${chalk.bold('No args:')} If no args are specified and an *.codify.json already exists, Codify 
+will update the existing file with new changes on the system.
 
-Command: codify import
+${chalk.underline('Command:')}
+codify import
 
-2. With args: specify specific resources to import using arguments. Wild card matching is supported using '*' and ? (Note: in zsh * expands to the current dir and needs to be escaped using \\* or '*'). A prompt will be shown if more information is required to complete the import.
+2. ${chalk.bold('With args:')} Specify specific resources to import using arguments. Wild card matching is supported 
+using '*' and '?' (${chalk.italic('Note: in zsh * expands to the current dir and needs to be escaped using \\* or \'*\'')}). 
+A prompt will be shown if more information is required to complete the import.
 
-Example: codify import nvm asdf\\*, codify import \\* (for importing all supported resources)
+${chalk.underline('Examples:')} 
+codify import nvm asdf
+codify import \\*,
+codify import \\* (for importing all supported resources)
 
-The results can then be saved:
+The results can be saved in one of three ways:
   a. To an existing *.codify.json file
   b. To a new file
-  c. Or only printed to console
+  c. Printed to the console only
   
-Codify will try to smartly insert new configs by following existing spacing and formatting.
-`
+Codify will attempt to smartly insert new configurations while preserving existing spacing and formatting.
+
+For more information, visit: https://docs.codifycli.com/commands/import`
 
   static override examples = [
     '<%= config.bin %> <%= command.id %> homebrew nvm asdf\\*',

src/commands/init.ts

@@ -1,24 +1,27 @@
-import fs from 'node:fs/promises';
+import chalk from 'chalk';
 
 import { BaseCommand } from '../common/base-command.js';
 import { InitializeOrchestrator } from '../orchestrators/init.js';
-import { ShellUtils } from '../utils/shell.js';
 
 export default class Init extends BaseCommand {
   static strict = false;
+
   static override description =
-`Initialize codify.`
+`A helper to quickly get started with Codify.
+
+Use this command to automatically generate Codify configs based on
+the currently installed system resources. By default, the new file 
+will be written to ${chalk.bold.bgMagenta(' ~/codify.json ')}.
+
+For more information, visit: https://docs.codifycli.com/commands/init`
 
   static baseFlags= {
     ...BaseCommand.baseFlags,
     path: { hidden: true },
   }
 
   static override examples = [
-    '<%= config.bin %> <%= command.id %> homebrew nvm asdf\\*',
     '<%= config.bin %> <%= command.id %>',
-    '<%= config.bin %> <%= command.id %> git-clone --path ../my/other/folder',
-    '<%= config.bin %> <%= command.id %> \\*'
   ]
 
   public async run(): Promise<void> {

src/commands/plan.ts

@@ -1,12 +1,25 @@
+import chalk from 'chalk';
 import { BaseCommand } from '../common/base-command.js';
 import { PlanOrchestrator } from '../orchestrators/plan.js';
 
 export default class Plan extends BaseCommand {
-  static description = 'Generate a plan based on a codify.json file. This plan will list ' +
-    'out the changes Codify will need to make in order to meet the desired config.'
+  static description =
+`Generate an execution plan to apply changes from a codify.json file.
+ 
+This plan lists all the changes Codify needs to make to apply the codify.json file.
+The plan will not be executed. Behind the scenes, Codify performs a refresh scan to 
+determine the current configuration and installed resources, then compares them with 
+the desired configuration to compute the execution plan.
+
+For scripts: use ${chalk.bold.bgMagenta(' --output json ')} which will skip all prompts and print
+ only the final result as a json.
+
+For more information, visit: https://docs.codifycli.com/commands/plan`
 
   static examples = [
     '<%= config.bin %> <%= command.id %>',
+    '<%= config.bin %> <%= command.id %> -o json',
+    '<%= config.bin %> <%= command.id %> -p ../',
   ]
 
   async init(): Promise<void> {

src/common/base-command.ts

@@ -18,7 +18,7 @@ export abstract class BaseCommand extends Command {
       char: 'o',
       default: 'default',
       options: ['plain', 'default', 'json'],
-      description: 'Control the output format of Codify.',
+      description: 'Control the output format.',
     })(),
     path: Flags.string({ char: 'p', description: 'Path to run Codify from.' }),
   }
@@ -34,6 +34,11 @@ export abstract class BaseCommand extends Command {
       strict: false,
     });
 
+    const debug = createDebug('codify');
+    if (debug.enabled || flags.debug) {
+      createDebug.enable('*');
+    }
+
     const reporterType = this.getReporterType(flags);
     this.reporter = ReporterFactory.create(reporterType)
 
@@ -61,17 +66,6 @@ export abstract class BaseCommand extends Command {
   }
 
   private getReporterType(flags: OutputFlags<any>): ReporterType {
-    const debug = createDebug('codify');
-
-    if (debug.enabled || flags.debug) {
-      createDebug.enable('*');
-      return ReporterType.DEBUG;
-    }
-
-    if (this.jsonEnabled()) {
-      return ReporterType.JSON;
-    }
-
     if (flags.output) {
       switch (flags.output) {
         case 'debug': {