Skip to content

Commit debfa6b

Browse files
acburdineErisDS
authored andcommitted
fix(help): update descriptions to be more helpful
closes #321 - add better descriptions to various commands
1 parent 1f77407 commit debfa6b

File tree

5 files changed

+6
-1
lines changed

5 files changed

+6
-1
lines changed

lib/commands/buster.js

+2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@ class BusterCommand extends Command {
99
}
1010

1111
BusterCommand.description = 'Who ya gonna call?';
12+
BusterCommand.longDescription = 'When there\'s something strange in your neighborhood....';
13+
BusterCommand.aliases = ['busters'];
1214

1315
module.exports = BusterCommand;

lib/commands/config/index.js

+1
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ class ConfigCommand extends Command {
153153
}
154154

155155
ConfigCommand.description = 'Configure a Ghost instance';
156+
ConfigCommand.longDescription = '$0 config [key] [value]\n View or modify the configuration for a Ghost instance.';
156157
ConfigCommand.params = '[key] [value]';
157158
ConfigCommand.options = advancedOptions;
158159

lib/commands/doctor/index.js

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ class DoctorCommand extends Command {
3333
}
3434

3535
DoctorCommand.description = 'Check the system for any potential hiccups when installing/updating Ghost';
36+
DoctorCommand.longDescription = '$0 doctor [install|startup]\n Run various checks to determine potential problems with your environment.'
3637
DoctorCommand.params = '[category]';
3738
DoctorCommand.global = true;
3839

lib/commands/install.js

+1
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ class InstallCommand extends Command {
117117

118118
InstallCommand.global = true;
119119
InstallCommand.description = 'Install a brand new instance of Ghost';
120+
InstallCommand.longDescription = '$0 install [version|local]\n Installs a new version of Ghost. Run `ghost install local` to install for local theme development/testing';
120121
InstallCommand.params = '[version]';
121122
InstallCommand.options = {
122123
dir: {

lib/commands/log.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class LogCommand extends Command {
7171
}
7272
}
7373

74-
LogCommand.description = 'View logs of a running Ghost process';
74+
LogCommand.description = 'View the logs of a Ghost instance';
7575
LogCommand.params = '[name]';
7676
LogCommand.options = {
7777
number: {

0 commit comments

Comments
 (0)