Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): Point users to the official documentation when they use n8n --help #8440

Merged
merged 2 commits into from
Jan 26, 2024
Merged

fix(core): Point users to the official documentation when they use n8n --help #8440

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f6f781
point users to the official documentation when they use `n8n --help`
despairblue Jan 25, 2024
277170e
make sure that the help for commands and topics still shows up
despairblue Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"types": "dist/index.d.ts",
"oclif": {
"commands": "./dist/commands",
"helpClass": "./dist/help",
"bin": "n8n"
},
"scripts": {
Expand Down
17 changes: 17 additions & 0 deletions packages/cli/src/help.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import type { Command } from '@oclif/core';
import { HelpBase } from '@oclif/core';

// oclif expects a default export
// eslint-disable-next-line import/no-default-export
export default class CustomHelp extends HelpBase {
async showHelp(_args: string[]) {
console.log(
'You can find up to date information about the CLI here:\nhttps://docs.n8n.io/hosting/cli-commands/',
);
}

async showCommandHelp(_command: Command.Loadable) {
// This is not used because we have a multi-command CLI, but it needs to
// be defined to satisfy the abstract base class.
}
}
Loading