aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/commands/help/USAGE
diff options
context:
space:
mode:
authorKasper Timm Hansen <kaspth@gmail.com>2016-09-26 20:28:40 +0200
committerGitHub <noreply@github.com>2016-09-26 20:28:40 +0200
commitc994a893c18c0456fd2a30efe4debfc2b18e2508 (patch)
tree0253b1343a1760dc4701f7d2ee2ff8cdd1d1b290 /railties/lib/rails/commands/help/USAGE
parenta6da7938017647dd6e19e23d3d47126cb7a3e1fe (diff)
parentc0c73738bd04c86fbcf6d22c961fec0d33aa2bf6 (diff)
downloadrails-c994a893c18c0456fd2a30efe4debfc2b18e2508.tar.gz
rails-c994a893c18c0456fd2a30efe4debfc2b18e2508.tar.bz2
rails-c994a893c18c0456fd2a30efe4debfc2b18e2508.zip
Merge pull request #26414 from rails/rails-commands
Initial Rails Commands Infrastructure
Diffstat (limited to 'railties/lib/rails/commands/help/USAGE')
-rw-r--r--railties/lib/rails/commands/help/USAGE27
1 files changed, 27 insertions, 0 deletions
diff --git a/railties/lib/rails/commands/help/USAGE b/railties/lib/rails/commands/help/USAGE
new file mode 100644
index 0000000000..348f41861f
--- /dev/null
+++ b/railties/lib/rails/commands/help/USAGE
@@ -0,0 +1,27 @@
+Usage: bin/rails COMMAND [args] [options]
+<% if engine? %>
+The common Rails commands available for engines are:
+ generate Generate new code (short-cut alias: "g")
+ destroy Undo code generated with "generate" (short-cut alias: "d")
+ test Run tests (short-cut alias: "t")
+
+All commands can be run with -h for more information.
+
+If you want to run any commands that need to be run in context
+of the application, like `bin/rails server` or `bin/rails console`,
+you should do it from the application's directory (typically test/dummy).
+<% else %>
+The most common rails commands are:
+ generate Generate new code (short-cut alias: "g")
+ console Start the Rails console (short-cut alias: "c")
+ server Start the Rails server (short-cut alias: "s")
+ test Run tests (short-cut alias: "t")
+ dbconsole Start a console for the database specified in config/database.yml
+ (short-cut alias: "db")
+ new Create a new Rails application. "rails new my_app" creates a
+ new application called MyApp in "./my_app"
+
+All commands can be run with -h (or --help) for more information.
+<% end %>
+In addition to those commands, there are:
+