refactor(cli): Wording and copy

Author: byawitz

templates/cli/index.js.twig

@@ -30,15 +30,16 @@ program
   .description(commandDescriptions['main'])
   .configureHelp({
     helpWidth: process.stdout.columns || 80,
-    sortSubcommands: true
+    sortSubcommands: true,
   })
-  .version(version, "-v, --version")
+  .helpOption('-h, --help', "Display help for command")
+  .version(version, "-v, --version", "Output the version number")
   .option("-V, --verbose", "Show complete error log")
   .option("-j, --json", "Output in JSON format")
   .hook('preAction', migrate)
   .option("-f,--force", "Flag to confirm all warnings")
   .option("-a,--all", "Flag to push all resources")
-  .option("--id [id...]", "Flag to pass list of ids for a giving action")
+  .option("--id [id...]", "Flag to pass a list of ids for a given action")
   .option("--report", "Enable reporting in case of CLI errors")
   .on("option:json", () => {
     cliConfig.json = true;

templates/cli/lib/commands/command.js.twig

@@ -35,7 +35,7 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower }}").description(commandDescriptions['{{ service.name | caseLower }}']).configureHelp({
+const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower }}").description(commandDescriptions['{{ service.name | caseLower }}'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 

templates/cli/lib/parser.js.twig

@@ -203,29 +203,26 @@ const commandDescriptions = {
     "account": `The account command allows you to authenticate and manage a user account.`,
     "graphql": `The graphql command allows you to query and mutate any resource type on your Appwrite server.`,
     "avatars": `The avatars command aims to help you complete everyday tasks related to your app image, icons, and avatars.`,
-    "databases": `The databases command allows you to create structured collections of documents, query and filter lists of documents.`,
-    "init": `The init command provides a convenient wrapper for creating and initializing project, functions, collections, buckets, teams and messaging in Appwrite.`,
-    "push": `The push command provides a convenient wrapper for pushing your functions, collections, buckets, teams and messaging.`,
-    "run": `The run command allows you to run project locally to allow easy development and quick debugging.`,
-    "functions": `The functions command allows you view, create and manage your Cloud Functions.`,
+    "databases": `The databases command allows you to create structured collections of documents and query and filter lists of documents.`,
+    "init": `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, and messaging-topics in  {{ spec.title|caseUcfirst }}.`,
+    "push": `The push command provides a convenient wrapper for pushing your functions, collections, buckets, teams, and messaging-topics.`,
+    "run": `The run command allows you to run the project locally to allow easy development and quick debugging.`,
+    "functions": `The functions command allows you to view, create, and manage your Cloud Functions.`,
     "health": `The health command allows you to both validate and monitor your {{ spec.title|caseUcfirst }} server's health.`,
-    "pull": `The pull command helps you pull your {{ spec.title|caseUcfirst }} project, functions, collections, buckets, teams and messaging`,
+    "pull": `The pull command helps you pull your {{ spec.title|caseUcfirst }} project, functions, collections, buckets, teams, and messaging-topics`,
     "locale": `The locale command allows you to customize your app based on your users' location.`,
-    "projects": `The projects command allows you to view, create and manage your {{ spec.title|caseUcfirst }} projects.`,
     "storage": `The storage command allows you to manage your project files.`,
-    "teams": `The teams command allows you to group users of your project and to enable them to share read and write access to your project resources`,
+    "teams": `The teams command allows you to group users of your project to enable them to share read and write access to your project resources.`,
     "users": `The users command allows you to manage your project users.`,
     "client": `The client command allows you to configure your CLI`,
     "login": `The login command allows you to authenticate and manage a user account.`,
-    "logout": `The logout command allows you to logout of your {{ spec.title|caseUcfirst }} account.`,
-    "whoami": `The whoami command gives information about the currently signed in user.`,
+    "logout": `The logout command allows you to log out of your {{ spec.title|caseUcfirst }} account.`,
+    "whoami": `The whomai command gives information about the currently logged-in user.`,
     "register": `Outputs the link to create an {{ spec.title|caseUcfirst }} account.`,
-    "console" : `The console command allows gives you access to the APIs used by the Appwrite console.`,
+    "console" : `The console command gives you access to the APIs used by the Appwrite Console.`,
     "assistant": `The assistant command allows you to interact with the Appwrite Assistant AI`,
-    "messaging": `The messaging command allows you to send messages.`,
+    "messaging": `The messaging command allows you to manage topics and targets and send messages.`,
     "migrations": `The migrations command allows you to migrate data between services.`,
-    "project": `The project command is for overall project administration.`,
-    "proxy": `The proxy command allows you to configure behavior for your attached domains.`,
     "vcs": `The vcs command allows you to interact with VCS providers and manage your code repositories.`,
     "main": chalk.redBright(`${logo}${description}`),
 {% if sdk.test == "true" %}