@chabokan.net/cli 0.8.15 → 0.9.0

package/oclif.manifest.json

@@ -3,7 +3,29 @@
     "deploy": {
       "aliases": [],
       "args": {},
-      "description": "this command help you build and deploy your service to chabokan in easy way.",
+      "description": "upload the current project and deploy it to a service",
+      "examples": [
+        {
+          "description": "Deploy the current directory, picking the service from a list",
+          "command": "<%= config.bin %> deploy"
+        },
+        {
+          "description": "Deploy the current directory to a named service",
+          "command": "<%= config.bin %> deploy --service my-app"
+        },
+        {
+          "description": "Deploy a project that lives somewhere else",
+          "command": "<%= config.bin %> deploy --path ./apps/api --service my-api"
+        },
+        {
+          "description": "Pin the target service in the project, so plain `deploy` always works",
+          "command": "echo '{\"service\": \"my-app\"}' > chabok.json && <%= config.bin %> deploy"
+        },
+        {
+          "description": "See exactly which files are excluded from the upload",
+          "command": "CHABOK_DEBUG=true <%= config.bin %> deploy -s my-app"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -14,7 +36,7 @@
         },
         "path": {
           "char": "p",
-          "description": "service path in your computer",
+          "description": "project directory to upload (defaults to the current directory)",
           "name": "path",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -22,7 +44,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to deploy to",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -47,7 +69,25 @@
     "login": {
       "aliases": [],
       "args": {},
-      "description": "login to hub.chabokan.net account",
+      "description": "sign in to your hub.chabokan.net account",
+      "examples": [
+        {
+          "description": "Sign in interactively (prompts for email and password)",
+          "command": "<%= config.bin %> login"
+        },
+        {
+          "description": "Sign in with an API token — the right choice for CI",
+          "command": "<%= config.bin %> login --token <your-api-token>"
+        },
+        {
+          "description": "Pass the email up front and be prompted only for the password",
+          "command": "<%= config.bin %> login --email me@example.com"
+        },
+        {
+          "description": "Add a second account (both stay signed in; switch with `account use`)",
+          "command": "<%= config.bin %> login --email other@example.com"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -57,8 +97,11 @@
           "type": "boolean"
         },
         "username": {
+          "aliases": [
+            "email"
+          ],
           "char": "u",
-          "description": "your username",
+          "description": "your email address",
           "name": "username",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -66,7 +109,7 @@
         },
         "password": {
           "char": "p",
-          "description": "your password",
+          "description": "your password (prompted for if omitted)",
           "name": "password",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -74,7 +117,7 @@
         },
         "token": {
           "char": "t",
-          "description": "login with api token",
+          "description": "API token, for non-interactive sign-in",
           "name": "token",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -96,10 +139,51 @@
         "login.js"
       ]
     },
+    "account:info": {
+      "aliases": [],
+      "args": {},
+      "description": "show information about the active account",
+      "examples": [
+        {
+          "description": "Show the active account's details",
+          "command": "<%= config.bin %> account info"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "account:info",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "account",
+        "info.js"
+      ]
+    },
     "account:list": {
       "aliases": [],
       "args": {},
-      "description": "show accounts list",
+      "description": "list the accounts you are logged in to",
+      "examples": [
+        {
+          "description": "Show every logged-in account and which one is active",
+          "command": "<%= config.bin %> account list"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -128,7 +212,13 @@
     "account:remove": {
       "aliases": [],
       "args": {},
-      "description": "remove account from list",
+      "description": "sign out of an account and forget its stored token",
+      "examples": [
+        {
+          "description": "Pick the account to sign out of",
+          "command": "<%= config.bin %> account remove"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -157,7 +247,17 @@
     "account:use": {
       "aliases": [],
       "args": {},
-      "description": "switch your default user between logged in users",
+      "description": "switch the active account",
+      "examples": [
+        {
+          "description": "Pick the account to switch to from a list",
+          "command": "<%= config.bin %> account use"
+        },
+        {
+          "description": "Switch to a specific account without prompting",
+          "command": "<%= config.bin %> account use --user me@example.com"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -168,7 +268,7 @@
         },
         "user": {
           "char": "u",
-          "description": "default user",
+          "description": "email of the account to switch to",
           "name": "user",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -191,10 +291,334 @@
         "use.js"
       ]
     },
+    "cloudserver:create": {
+      "aliases": [],
+      "args": {},
+      "description": "create a new cloud server (VPS) — walks through provider, location, plan, OS and wallet",
+      "examples": [
+        {
+          "description": "Create a cloud server, choosing every option interactively",
+          "command": "<%= config.bin %> cloudserver create"
+        },
+        {
+          "description": "Skip the hostname prompt",
+          "command": "<%= config.bin %> cloudserver create --hostname my-vps"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hostname": {
+          "description": "hostname for the new cloud server",
+          "name": "hostname",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "wallet": {
+          "description": "name of the wallet to pay from",
+          "name": "wallet",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:create",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "create.js"
+      ]
+    },
+    "cloudserver:delete": {
+      "aliases": [],
+      "args": {},
+      "description": "permanently delete a cloud server",
+      "examples": [
+        {
+          "description": "Pick a cloud server from an interactive list, then confirm",
+          "command": "<%= config.bin %> cloudserver delete"
+        },
+        {
+          "description": "Delete a specific cloud server without a confirmation prompt",
+          "command": "<%= config.bin %> cloudserver delete --hostname my-vps --yes"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hostname": {
+          "description": "hostname of the cloud server to delete",
+          "name": "hostname",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "yes": {
+          "char": "y",
+          "description": "skip the confirmation prompt",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:delete",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "delete.js"
+      ]
+    },
+    "cloudserver:list": {
+      "aliases": [],
+      "args": {},
+      "description": "list the cloud servers (VPS) on your account",
+      "examples": [
+        {
+          "description": "List every cloud server on the active account",
+          "command": "<%= config.bin %> cloudserver list"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:list",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "list.js"
+      ]
+    },
+    "cloudserver:restart": {
+      "aliases": [],
+      "args": {},
+      "description": "restart a cloud server",
+      "examples": [
+        {
+          "description": "Pick a cloud server from an interactive list",
+          "command": "<%= config.bin %> cloudserver restart"
+        },
+        {
+          "description": "Restart a specific cloud server by hostname",
+          "command": "<%= config.bin %> cloudserver restart --hostname my-vps"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hostname": {
+          "description": "hostname of the cloud server to restart",
+          "name": "hostname",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:restart",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "restart.js"
+      ]
+    },
+    "cloudserver:start": {
+      "aliases": [],
+      "args": {},
+      "description": "turn on a cloud server",
+      "examples": [
+        {
+          "description": "Pick a cloud server from an interactive list",
+          "command": "<%= config.bin %> cloudserver start"
+        },
+        {
+          "description": "Turn on a specific cloud server by hostname",
+          "command": "<%= config.bin %> cloudserver start --hostname my-vps"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hostname": {
+          "description": "hostname of the cloud server to turn on",
+          "name": "hostname",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:start",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "start.js"
+      ]
+    },
+    "cloudserver:stop": {
+      "aliases": [],
+      "args": {},
+      "description": "turn off a cloud server",
+      "examples": [
+        {
+          "description": "Pick a cloud server from an interactive list",
+          "command": "<%= config.bin %> cloudserver stop"
+        },
+        {
+          "description": "Turn off a specific cloud server by hostname",
+          "command": "<%= config.bin %> cloudserver stop --hostname my-vps"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hostname": {
+          "description": "hostname of the cloud server to turn off",
+          "name": "hostname",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloudserver:stop",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloudserver",
+        "stop.js"
+      ]
+    },
+    "wallet:list": {
+      "aliases": [],
+      "args": {},
+      "description": "list the wallets on your account",
+      "examples": [
+        {
+          "description": "Show every wallet and its balance",
+          "command": "<%= config.bin %> wallet list"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "wallet:list",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "wallet",
+        "list.js"
+      ]
+    },
     "service:list": {
       "aliases": [],
       "args": {},
-      "description": "show account services list",
+      "description": "list the services on your account",
+      "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"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -223,7 +647,25 @@
     "service:logs": {
       "aliases": [],
       "args": {},
-      "description": "read latest logs from service",
+      "description": "read the latest logs from a service",
+      "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"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -234,7 +676,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to read logs from",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -260,7 +702,21 @@
     "service:resize": {
       "aliases": [],
       "args": {},
-      "description": "resize a service",
+      "description": "change the RAM, CPU and disk allocated to a service",
+      "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"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -271,7 +727,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to resize",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -279,7 +735,7 @@
         },
         "ram": {
           "char": "r",
-          "description": "RAM",
+          "description": "RAM in GB, in steps of 0.5 (e.g. 0.5, 1, 2)",
           "name": "ram",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -287,7 +743,7 @@
         },
         "cpu": {
           "char": "c",
-          "description": "CPU",
+          "description": "CPU cores, in steps of 0.5 (e.g. 0.5, 1, 2)",
           "name": "cpu",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -295,7 +751,7 @@
         },
         "disk": {
           "char": "d",
-          "description": "DISK",
+          "description": "disk in GB, in steps of 5 (e.g. 5, 10, 30)",
           "name": "disk",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -322,6 +778,20 @@
       "aliases": [],
       "args": {},
       "description": "restart a service",
+      "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"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -332,7 +802,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to restart",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -358,7 +828,21 @@
     "service:start": {
       "aliases": [],
       "args": {},
-      "description": "start a service",
+      "description": "start a stopped service",
+      "examples": [
+        {
+          "description": "Pick a service from an interactive list",
+          "command": "<%= config.bin %> service start"
+        },
+        {
+          "description": "Start a specific service by name",
+          "command": "<%= config.bin %> service start --service my-app"
+        },
+        {
+          "description": "Same, using the short flag",
+          "command": "<%= config.bin %> service start -s my-app"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -369,7 +853,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to start",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -395,7 +879,21 @@
     "service:stop": {
       "aliases": [],
       "args": {},
-      "description": "stop a service",
+      "description": "stop a running service",
+      "examples": [
+        {
+          "description": "Pick a service from an interactive list",
+          "command": "<%= config.bin %> service stop"
+        },
+        {
+          "description": "Stop a specific service by name",
+          "command": "<%= config.bin %> service stop --service my-app"
+        },
+        {
+          "description": "Same, using the short flag",
+          "command": "<%= config.bin %> service stop -s my-app"
+        }
+      ],
       "flags": {
         "help": {
           "char": "h",
@@ -406,7 +904,7 @@
         },
         "service": {
           "char": "s",
-          "description": "service name",
+          "description": "name of the service to stop",
           "name": "service",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -428,7 +926,119 @@
         "service",
         "stop.js"
       ]
+    },
+    "service:domain:add": {
+      "aliases": [],
+      "args": {},
+      "description": "connect a custom domain to a service",
+      "examples": [
+        {
+          "description": "Pick the service and enter the domain interactively",
+          "command": "<%= config.bin %> service domain add"
+        },
+        {
+          "description": "Connect a domain in one non-interactive command",
+          "command": "<%= config.bin %> service domain add -s my-app -d www.example.com"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "service": {
+          "char": "s",
+          "description": "name of the service to connect the domain to",
+          "name": "service",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "char": "d",
+          "description": "domain name to connect, e.g. www.example.com",
+          "name": "domain",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "service:domain:add",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "service",
+        "domain",
+        "add.js"
+      ]
+    },
+    "service:domain:remove": {
+      "aliases": [],
+      "args": {},
+      "description": "disconnect a custom domain from a service",
+      "examples": [
+        {
+          "description": "Pick the service and enter the domain interactively",
+          "command": "<%= config.bin %> service domain remove"
+        },
+        {
+          "description": "Disconnect a domain in one non-interactive command",
+          "command": "<%= config.bin %> service domain remove -s my-app -d www.example.com"
+        }
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "service": {
+          "char": "s",
+          "description": "name of the service the domain is connected to",
+          "name": "service",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "char": "d",
+          "description": "domain name to disconnect",
+          "name": "domain",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "service:domain:remove",
+      "pluginAlias": "@chabokan.net/cli",
+      "pluginName": "@chabokan.net/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "service",
+        "domain",
+        "remove.js"
+      ]
     }
   },
-  "version": "0.8.15"
+  "version": "0.9.0"
 }