@chabokan.net/cli 0.8.15 → 0.9.0

package/dist/commands/service/list.js

@@ -1,44 +1,52 @@
 import Command from "../../base.js";
-import { ux } from "@oclif/core";
-import chalk from "chalk";
-import { isEmptyObject, handleApiError, logErrorDetails } from "../../helper.js";
+import { printTable } from "@oclif/table";
+import * as ui from "../../ui.js";
+import { handleApiError, logErrorDetails } from "../../helper.js";
 export default class ServiceList extends Command {
-    static description = "show account services list";
+    static description = "list the services on your account";
+    static examples = [
+        {
+            description: 'List every service on the active account',
+            command: '<%= config.bin %> service list',
+        },
+        {
+            description: 'Switch account first, then list that account’s services',
+            command: '<%= config.bin %> account use -u me@example.com && <%= config.bin %> service list',
+        },
+    ];
     static flags = {
         ...Command.flags,
     };
     async run() {
-        const { flags } = await this.parse(ServiceList);
+        await this.parse(ServiceList);
         const cli = this;
         try {
             await this.init_run();
-            const config_json = await this.read_config();
-            if (isEmptyObject(config_json.users)) {
-                cli.log(`${chalk.red('[Error]')} Please login first using 'chabok login'.`);
+            if (!(await this.require_login())) {
                 return;
             }
             const all_services = await this.get_services();
-            if (all_services.length > 0) {
-                const services_data = all_services.map((service) => {
-                    return {
-                        Name: service.name,
-                    };
-                });
-                ux.table(services_data, {
-                    Name: {},
-                }, flags);
-            }
-            else {
-                cli.log(`${chalk.yellow('[Info]')} No services found. Please create a service first.`);
+            if (all_services.length === 0) {
+                cli.log(ui.info('You have no services yet.'));
+                cli.log(ui.hint('Create one at https://hub.chabokan.net, then come back here'));
                 return;
             }
+            const services_data = all_services.map((service) => ({
+                Service: service.value,
+                Platform: service.platform,
+            }));
+            printTable({
+                data: services_data,
+                columns: ["Service", "Platform"],
+            });
+            cli.log(ui.hint(`Act on one with ${ui.cmd('chabok service logs -s <name>')}, ${ui.cmd('restart')}, ${ui.cmd('stop')} …`));
         }
         catch (error) {
             const errorInfo = handleApiError(error, 'Failed to fetch services list.', {
                 endpoint: 'services/',
                 operation: 'List Services'
             });
-            cli.log(`${chalk.red('[Error]')} ${errorInfo.message}`);
+            cli.log(ui.error(errorInfo.message));
             logErrorDetails(errorInfo, cli);
         }
     }

package/dist/commands/service/logs.d.ts

@@ -1,9 +1,13 @@
 import Command from "../../base.js";
 export default class ServiceLogs extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        service: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
     send_request(cli: Command, selected_service: string): Promise<void>;

package/dist/commands/service/logs.js

@@ -1,53 +1,55 @@
 import { Flags } from '@oclif/core';
 import Command from "../../base.js";
-import { isEmptyObject, handleApiError, logErrorDetails } from "../../helper.js";
-import chalk from "chalk";
-import inquirer from 'inquirer';
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import axios from "axios";
 export default class ServiceLogs extends Command {
-    static description = 'read latest logs from service';
+    static description = 'read the latest logs from a service';
+    static examples = [
+        {
+            description: 'Pick a service from an interactive list',
+            command: '<%= config.bin %> service logs',
+        },
+        {
+            description: 'Read logs for a specific service',
+            command: '<%= config.bin %> service logs --service my-app',
+        },
+        {
+            description: 'Search the logs for errors',
+            command: '<%= config.bin %> service logs -s my-app | grep -i error',
+        },
+        {
+            description: 'Save the logs to a file',
+            command: '<%= config.bin %> service logs -s my-app > my-app.log',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: 's', description: 'service name' }),
+        service: Flags.string({ char: 's', description: 'name of the service to read logs from' }),
     };
     async run() {
         const { flags } = await this.parse(ServiceLogs);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red('[Error]')} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
-        if (!flags.service) {
-            const all_services = await this.get_services();
-            if (all_services.length > 0) {
-                const { service } = await inquirer.prompt({
-                    type: 'list',
-                    message: 'Please select a service:',
-                    name: 'service',
-                    choices: all_services
-                });
-                selected_service = service;
-            }
-            else {
-                cli.log("first you should create service");
-                return;
-            }
-        }
-        if (selected_service) {
-            await this.send_request(cli, selected_service);
+        const selected_service = await this.select_service(flags.service, {}, 'Fetch Logs');
+        if (!selected_service) {
+            return;
         }
+        await this.send_request(cli, selected_service);
     }
     async send_request(cli, selected_service) {
         try {
             const { data } = await axios.get(`services/${selected_service}/logs/`, this.axiosConfig);
             if (data.success && data.logs) {
+                // Logs go out verbatim so they stay pipeable into grep, tee and friends.
                 cli.log(data.logs);
             }
             else {
-                cli.log(`${chalk.yellow('[Warning]')} No logs available for service '${selected_service}'. The service may not have generated any logs yet.`);
+                cli.log(ui.info(`No logs yet for ${ui.value(selected_service)}.`));
+                cli.log(ui.hint('A service that has just started may take a moment to produce output'));
             }
         }
         catch (error) {
@@ -57,10 +59,11 @@ export default class ServiceLogs extends Command {
                 operation: 'Fetch Logs'
             });
             if (errorInfo.status === 404) {
-                cli.log(`${chalk.red('[Error]')} Service '${selected_service}' not found. Please verify the service name using 'chabok service list' and try again.`);
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else {
-                cli.log(`${chalk.red('[Error]')} ${errorInfo.message}`);
+                cli.log(ui.error(errorInfo.message));
             }
             logErrorDetails(errorInfo, cli);
         }

package/dist/commands/service/resize.d.ts

@@ -1,12 +1,16 @@
 import Command from "../../base.js";
 export default class ServiceResize extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        service: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        ram: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        cpu: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        disk: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        ram: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        cpu: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        disk: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
     send_request(cli: Command, selected_service: string, ram: string, cpu: string, disk: string): Promise<void>;

package/dist/commands/service/resize.js

@@ -1,130 +1,132 @@
 import { Flags } from '@oclif/core';
 import Command from "../../base.js";
-import { isEmptyObject, handleApiError, logErrorDetails } from "../../helper.js";
-import chalk from "chalk";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import inquirer from 'inquirer';
 import axios from "axios";
 export default class ServiceResize extends Command {
-    static description = 'resize a service';
+    static description = 'change the RAM, CPU and disk allocated to a service';
+    static examples = [
+        {
+            description: 'Choose the service and every resource interactively',
+            command: '<%= config.bin %> service resize',
+        },
+        {
+            description: 'Resize a service in one non-interactive command',
+            command: '<%= config.bin %> service resize -s my-app --ram 2 --cpu 1 --disk 10',
+        },
+        {
+            description: 'Set only the RAM and pick the rest from the prompts',
+            command: '<%= config.bin %> service resize -s my-app --ram 4',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: 's', description: 'service name' }),
-        ram: Flags.string({ char: 'r', description: 'RAM' }),
-        cpu: Flags.string({ char: 'c', description: 'CPU' }),
-        disk: Flags.string({ char: 'd', description: 'DISK' }),
+        service: Flags.string({ char: 's', description: 'name of the service to resize' }),
+        ram: Flags.string({ char: 'r', description: 'RAM in GB, in steps of 0.5 (e.g. 0.5, 1, 2)' }),
+        cpu: Flags.string({ char: 'c', description: 'CPU cores, in steps of 0.5 (e.g. 0.5, 1, 2)' }),
+        disk: Flags.string({ char: 'd', description: 'disk in GB, in steps of 5 (e.g. 5, 10, 30)' }),
     };
     async run() {
         const { flags } = await this.parse(ServiceResize);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
         let selected_ram = flags.ram;
         let selected_cpu = flags.cpu;
         let selected_disk = flags.disk;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red('[Error]')} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
+        const selected_service = await this.select_service(flags.service, { 'not_status': 'pending', 'has_custom_plan': 'true' }, 'Resize Service');
         if (!selected_service) {
-            const all_services = await this.get_services({ 'not_status': 'pending', 'has_custom_plan': 'true' });
-            if (all_services && all_services.length > 0) {
-                const { service } = await inquirer.prompt({
-                    type: 'list',
-                    message: 'Please select a service:',
-                    name: 'service',
-                    choices: all_services
-                });
-                selected_service = service;
-            }
-            else {
-                cli.log("No services available for resize.");
-                return;
-            }
+            return;
         }
         if (!selected_ram) {
             const { ram } = await inquirer.prompt({
-                type: 'list',
-                message: 'Please select service ram:',
+                type: 'select',
+                message: 'RAM:',
                 name: 'ram',
                 choices: [
-                    { value: "0.5", name: "0.5G" },
-                    { value: "1", name: "1G" },
-                    { value: "2", name: "2G" },
-                    { value: "4", name: "4G" },
-                    { value: "6", name: "6G" },
-                    { value: "8", name: "8G" },
+                    { value: "0.5", name: "0.5 GB" },
+                    { value: "1", name: "1 GB" },
+                    { value: "2", name: "2 GB" },
+                    { value: "4", name: "4 GB" },
+                    { value: "6", name: "6 GB" },
+                    { value: "8", name: "8 GB" },
                 ]
             });
             selected_ram = ram;
         }
         if (!selected_cpu) {
             const { cpu } = await inquirer.prompt({
-                type: 'list',
-                message: 'Please select service cpu:',
+                type: 'select',
+                message: 'CPU:',
                 name: 'cpu',
                 choices: [
-                    { value: "0.5", name: "0.5 Core" },
-                    { value: "1", name: "1 Core" },
-                    { value: "2", name: "2 Core" },
-                    { value: "3", name: "3 Core" },
-                    { value: "4", name: "4 Core" },
+                    { value: "0.5", name: "0.5 core" },
+                    { value: "1", name: "1 core" },
+                    { value: "2", name: "2 cores" },
+                    { value: "3", name: "3 cores" },
+                    { value: "4", name: "4 cores" },
                 ]
             });
             selected_cpu = cpu;
         }
         if (!selected_disk) {
             const { disk } = await inquirer.prompt({
-                type: 'list',
-                message: 'Please select service disk:',
+                type: 'select',
+                message: 'Disk:',
                 name: 'disk',
                 choices: [
-                    { value: "5", name: "5G" },
-                    { value: "10", name: "10G" },
-                    { value: "15", name: "15G" },
-                    { value: "30", name: "30G" },
-                    { value: "40", name: "40G" },
-                    { value: "50", name: "50G" },
+                    { value: "5", name: "5 GB" },
+                    { value: "10", name: "10 GB" },
+                    { value: "15", name: "15 GB" },
+                    { value: "30", name: "30 GB" },
+                    { value: "40", name: "40 GB" },
+                    { value: "50", name: "50 GB" },
                 ]
             });
             selected_disk = disk;
         }
-        if (!selected_service || !selected_ram || !selected_cpu || !selected_disk) {
-            cli.log(`${chalk.red('[Error]')} All parameters are required.`);
+        if (!selected_ram || !selected_cpu || !selected_disk) {
+            cli.log(ui.error('RAM, CPU and disk are all required.'));
             return;
         }
         let wrong_value = false;
-        const ramNum = parseFloat(selected_ram);
-        const cpuNum = parseFloat(selected_cpu);
-        const diskNum = parseFloat(selected_disk);
-        if (isNaN(ramNum) || ramNum % 0.5 !== 0) {
-            cli.log(`${chalk.red('[Error]')} RAM amount should be a multiple of 0.5`);
+        const ramNum = Number.parseFloat(selected_ram);
+        const cpuNum = Number.parseFloat(selected_cpu);
+        const diskNum = Number.parseFloat(selected_disk);
+        if (Number.isNaN(ramNum) || ramNum % 0.5 !== 0) {
+            cli.log(ui.error(`RAM must be a multiple of 0.5 GB, got ${ui.value(selected_ram)}.`));
             wrong_value = true;
         }
-        if (isNaN(cpuNum) || cpuNum % 0.5 !== 0) {
-            cli.log(`${chalk.red('[Error]')} CPU amount should be a multiple of 0.5`);
+        if (Number.isNaN(cpuNum) || cpuNum % 0.5 !== 0) {
+            cli.log(ui.error(`CPU must be a multiple of 0.5 cores, got ${ui.value(selected_cpu)}.`));
             wrong_value = true;
         }
-        if (isNaN(diskNum) || diskNum % 5 !== 0) {
-            cli.log(`${chalk.red('[Error]')} Disk amount should be a multiple of 5`);
+        if (Number.isNaN(diskNum) || diskNum % 5 !== 0) {
+            cli.log(ui.error(`Disk must be a multiple of 5 GB, got ${ui.value(selected_disk)}.`));
             wrong_value = true;
         }
-        if (!wrong_value) {
-            await this.send_request(cli, selected_service, selected_ram, selected_cpu, selected_disk);
+        if (wrong_value) {
+            cli.log(ui.hint(`Example: ${ui.cmd(`chabok service resize -s ${selected_service} --ram 2 --cpu 1 --disk 10`)}`));
+            return;
         }
+        await this.send_request(cli, selected_service, selected_ram, selected_cpu, selected_disk);
     }
     async send_request(cli, selected_service, ram, cpu, disk) {
         try {
             const { data } = await axios.post(`services/${selected_service}/resize/`, {
-                ram: ram,
-                cpu: cpu,
-                disk: disk,
+                ram,
+                cpu,
+                disk,
             }, this.axiosConfig);
             if (data.success) {
-                cli.log(`${chalk.green('[Success]')} Service '${selected_service}' resized successfully (RAM: ${ram}G, CPU: ${cpu} cores, Disk: ${disk}G).`);
+                cli.log(ui.success(`Service ${ui.value(selected_service)} resized to ${ui.value(`${ram} GB RAM`)}, ${ui.value(`${cpu} CPU`)}, ${ui.value(`${disk} GB disk`)}.`));
+                cli.log(ui.hint(`Restart it to apply the new limits: ${ui.cmd(`chabok service restart -s ${selected_service}`)}`));
             }
             else {
-                cli.log(`${chalk.red('[Error]')} Failed to resize service '${selected_service}'. ${data.message || 'Please verify the resource values and try again.'}`);
+                cli.log(ui.error(`Could not resize ${ui.value(selected_service)}. ${data.message || 'Check the resource values and try again.'}`));
             }
         }
         catch (error) {
@@ -134,13 +136,15 @@ export default class ServiceResize extends Command {
                 operation: 'Resize Service'
             });
             if (errorInfo.status === 404) {
-                cli.log(`${chalk.red('[Error]')} Service '${selected_service}' not found. Please verify the service name using 'chabok service list' and try again.`);
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else if (errorInfo.status === 400 || errorInfo.status === 422) {
-                cli.log(`${chalk.red('[Error]')} Invalid resize parameters: ${errorInfo.message}. Please check that RAM is a multiple of 0.5, CPU is a multiple of 0.5, and Disk is a multiple of 5.`);
+                cli.log(ui.error(errorInfo.message));
+                cli.log(ui.hint('RAM and CPU go in steps of 0.5; disk goes in steps of 5'));
             }
             else {
-                cli.log(`${chalk.red('[Error]')} ${errorInfo.message}`);
+                cli.log(ui.error(errorInfo.message));
             }
             logErrorDetails(errorInfo, cli);
         }

package/dist/commands/service/restart.d.ts

@@ -1,9 +1,13 @@
 import Command from "../../base.js";
 export default class ServiceRestart extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        service: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
     send_request(cli: Command, selected_service: string): Promise<void>;

package/dist/commands/service/restart.js

@@ -1,55 +1,50 @@
 import { Flags } from "@oclif/core";
 import Command from "../../base.js";
-import { isEmptyObject, handleApiError, logErrorDetails } from "../../helper.js";
-import chalk from "chalk";
-import inquirer from "inquirer";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import axios from "axios";
 export default class ServiceRestart extends Command {
     static description = "restart a service";
+    static examples = [
+        {
+            description: 'Pick a service from an interactive list',
+            command: '<%= config.bin %> service restart',
+        },
+        {
+            description: 'Restart a specific service by name',
+            command: '<%= config.bin %> service restart --service my-app',
+        },
+        {
+            description: 'Restart, then tail the logs to confirm it came back up',
+            command: '<%= config.bin %> service restart -s my-app && <%= config.bin %> service logs -s my-app',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: "s", description: "service name" }),
+        service: Flags.string({ char: "s", description: "name of the service to restart" }),
     };
     async run() {
         const { flags } = await this.parse(ServiceRestart);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red("[Error]")} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
-        if (!flags.service) {
-            const all_services = await this.get_services({
-                not_status: "pending",
-            });
-            if (all_services && all_services.length > 0) {
-                const { service } = await inquirer.prompt({
-                    type: "list",
-                    message: "Please select a service:",
-                    name: "service",
-                    choices: all_services,
-                });
-                selected_service = service;
-            }
-            else {
-                cli.log("No services available.");
-                return;
-            }
-        }
-        if (selected_service) {
-            await this.send_request(cli, selected_service);
+        const selected_service = await this.select_service(flags.service, { not_status: "pending" }, "Restart Service");
+        if (!selected_service) {
+            return;
         }
+        await this.send_request(cli, selected_service);
     }
     async send_request(cli, selected_service) {
         try {
             const { data } = await axios.get(`services/${selected_service}/restart/`, this.axiosConfig);
             if (data.success) {
-                cli.log(`${chalk.green("[Success]")} Service '${selected_service}' restarted successfully.`);
+                cli.log(ui.success(`Service ${ui.value(selected_service)} is restarting.`));
+                cli.log(ui.hint(`Follow its output with ${ui.cmd(`chabok service logs -s ${selected_service}`)}`));
             }
             else {
-                cli.log(`${chalk.red("[Error]")} Failed to restart service '${selected_service}'. ${data.message || 'Please try again later.'}`);
+                cli.log(ui.error(`Could not restart ${ui.value(selected_service)}. ${data.message || 'Please try again in a moment.'}`));
             }
         }
         catch (error) {
@@ -59,10 +54,11 @@ export default class ServiceRestart extends Command {
                 operation: 'Restart Service'
             });
             if (errorInfo.status === 404) {
-                cli.log(`${chalk.red("[Error]")} Service '${selected_service}' not found. Please verify the service name using 'chabok service list' and try again.`);
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else {
-                cli.log(`${chalk.red("[Error]")} ${errorInfo.message}`);
+                cli.log(ui.error(errorInfo.message));
             }
             logErrorDetails(errorInfo, cli);
         }

package/dist/commands/service/start.d.ts

@@ -1,9 +1,13 @@
 import Command from "../../base.js";
 export default class ServiceStart extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        service: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
     send_request(cli: Command, selected_service: string): Promise<void>;