fix(core): Point users to the official documentation when they use `n…

…8n --help` (#8440)
n8n-io · Jan 26, 2024 · 9f11eba · 9f11eba
1 parent 70af67e
commit 9f11eba
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -16,6 +16,7 @@
   "types": "dist/index.d.ts",
   "oclif": {
     "commands": "./dist/commands",
+    "helpClass": "./dist/help",
     "bin": "n8n"
   },
   "scripts": {

diff --git a/packages/cli/src/help.ts b/packages/cli/src/help.ts
@@ -0,0 +1,11 @@
+import { Help } from '@oclif/core';
+
+// oclif expects a default export
+// eslint-disable-next-line import/no-default-export
+export default class CustomHelp extends Help {
+	async showRootHelp() {
+		console.log(
+			'You can find up to date information about the CLI here:\nhttps://docs.n8n.io/hosting/cli-commands/',
+		);
+	}
+}