Skip to content

Commit 3e427da

Browse files
committed
Make the buffalo verification use the "help" subcommand
As of version v0.16.17, the `buffalo` command with no subcommand returns an error after printing out the help message e.g. `ERRO[0000] Error: subcommand is required` Thus adding the help subcommand avoids displaying that error to the new buffalo user. I also updated the output of the help command to the match the latest version.
1 parent 972422f commit 3e427da

File tree

3 files changed

+42
-39
lines changed

3 files changed

+42
-39
lines changed

templates/en/docs/getting-started/installation.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -130,26 +130,27 @@ These instructions can also be used for upgrading to a newer version of Buffalo.
130130
You can check if your installation is working, by executing the `buffalo` command in a terminal/command prompt:
131131

132132
```bash
133-
$ buffalo
134-
Helps you build your Buffalo applications that much easier!
133+
$ buffalo help
134+
Build Buffalo applications with ease
135135

136136
Usage:
137137
buffalo [command]
138138

139139
Available Commands:
140-
build Builds a Buffalo binary, including bundling of assets (packr & webpack)
141-
db A tasty treat for all your database needs
142-
destroy Allows to destroy generated code.
143-
dev Runs your Buffalo app in 'development' mode
144-
generate A collection of generators to make life easier
140+
build Build the application binary, including bundling of assets (packr & webpack)
141+
destroy Destroy generated components
142+
dev Run the Buffalo app in 'development' mode
143+
fix Attempt to fix a Buffalo application's API to match version v0.16.17
144+
generate Generate application components
145145
help Help about any command
146-
info Prints off diagnostic information useful for debugging.
146+
info Print diagnostic information (useful for debugging)
147147
new Creates a new Buffalo application
148-
setup Setups a newly created, or recently checked out application.
149-
task Runs your grift tasks
150-
test Runs the tests for your Buffalo app
151-
update will attempt to upgrade a Buffalo application to version v<%= version %>
152-
version Print the version number of buffalo
148+
plugins tools for working with buffalo plugins
149+
routes Print all defined routes
150+
setup Setup a newly created, or recently checked out application.
151+
task Run grift tasks
152+
test Run the tests for the Buffalo app. Use --force-migrations to skip schema load.
153+
version Print the version information
153154
154155
Flags:
155156
-h, --help help for buffalo

templates/fr/docs/getting-started/installation.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -130,26 +130,27 @@ Ces instructions peuvent également être utilisées pour mettre à jour votre v
130130
Vous pouvez vérifier que votre installation fonctionne, en exécutant la commande `buffalo` dans un terminal (ou console) :
131131

132132
```bash
133-
$ buffalo
134-
Helps you build your Buffalo applications that much easier!
133+
$ buffalo help
134+
Build Buffalo applications with ease
135135

136136
Usage:
137137
buffalo [command]
138138

139139
Available Commands:
140-
build Builds a Buffalo binary, including bundling of assets (packr & webpack)
141-
db A tasty treat for all your database needs
142-
destroy Allows to destroy generated code.
143-
dev Runs your Buffalo app in 'development' mode
144-
generate A collection of generators to make life easier
140+
build Build the application binary, including bundling of assets (packr & webpack)
141+
destroy Destroy generated components
142+
dev Run the Buffalo app in 'development' mode
143+
fix Attempt to fix a Buffalo application's API to match version v0.16.17
144+
generate Generate application components
145145
help Help about any command
146-
info Prints off diagnostic information useful for debugging.
146+
info Print diagnostic information (useful for debugging)
147147
new Creates a new Buffalo application
148-
setup Setups a newly created, or recently checked out application.
149-
task Runs your grift tasks
150-
test Runs the tests for your Buffalo app
151-
update will attempt to upgrade a Buffalo application to version v<%= version %>
152-
version Print the version number of buffalo
148+
plugins tools for working with buffalo plugins
149+
routes Print all defined routes
150+
setup Setup a newly created, or recently checked out application.
151+
task Run grift tasks
152+
test Run the tests for the Buffalo app. Use --force-migrations to skip schema load.
153+
version Print the version information
153154
154155
Flags:
155156
-h, --help help for buffalo

templates/it/docs/getting-started/installation.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -130,26 +130,27 @@ Queste istruzioni possono essere usate anche per aggiornare Buffalo a una nuova
130130
Puoi verificare se hai installato tutto in maniera corretta eseguendo il comando `buffalo` in un terminale/prompt dei comandi:
131131

132132
```bash
133-
$ buffalo
134-
Helps you build your Buffalo applications that much easier!
133+
$ buffalo help
134+
Build Buffalo applications with ease
135135

136136
Usage:
137137
buffalo [command]
138138

139139
Available Commands:
140-
build Builds a Buffalo binary, including bundling of assets (packr & webpack)
141-
db A tasty treat for all your database needs
142-
destroy Allows to destroy generated code.
143-
dev Runs your Buffalo app in 'development' mode
144-
generate A collection of generators to make life easier
140+
build Build the application binary, including bundling of assets (packr & webpack)
141+
destroy Destroy generated components
142+
dev Run the Buffalo app in 'development' mode
143+
fix Attempt to fix a Buffalo application's API to match version v0.16.17
144+
generate Generate application components
145145
help Help about any command
146-
info Prints off diagnostic information useful for debugging.
146+
info Print diagnostic information (useful for debugging)
147147
new Creates a new Buffalo application
148-
setup Setups a newly created, or recently checked out application.
149-
task Runs your grift tasks
150-
test Runs the tests for your Buffalo app
151-
update will attempt to upgrade a Buffalo application to version v<%= version %>
152-
version Print the version number of buffalo
148+
plugins tools for working with buffalo plugins
149+
routes Print all defined routes
150+
setup Setup a newly created, or recently checked out application.
151+
task Run grift tasks
152+
test Run the tests for the Buffalo app. Use --force-migrations to skip schema load.
153+
version Print the version information
153154
154155
Flags:
155156
-h, --help help for buffalo

0 commit comments

Comments
 (0)