forked from geddy/geddy
/
usage.txt
86 lines (75 loc) · 4.5 KB
/
usage.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
=======================================================
Geddy web framework for Node.js
=======================================================
Server usage:
geddy [options] Runs a Geddy server for the current app directory
Server options:
--environment, -e Environment to use
--hostname, -b Host name or IP to bind the server to
(default: localhost)
--port, -p Port to bind the server to (default: 4000)
--geddy-root, -g /path/to/approot The path to the root for the app you want
to run (default is current working directory)
--workers, -w Number of worker processes to start (default: 1)
--debug, -d Sets the log level to output debug messages to
the console
--help, -h Output this usage dialog
--version, -v Output the version of Geddy that\'s installed
Server examples:
geddy Start Geddy on localhost:4000 in development mode
or if the directory isn\'t a Geddy app it\'ll
display a prompt to use "geddy -h"
geddy -p 3000 Start Geddy on port 3000
geddy -e production Start Geddy in production mode
geddy -j scaffold user Generate a users scaffolding using Jade templates
-------------------------------------------------------
Console usage:
geddy console Runs a REPL in the context of your app
-------------------------------------------------------
Jake usage:
geddy jake [task] [options] [env vars]
Runs a Jake task in the context of your app
Jake options:
(See https://github.com/mde/jake for full documentation)
Jake examples:
geddy jake test Run your application's tests in the app environment
geddy jake db:init environment=development
Initialize the development database for your app
geddy jake routes Show all routes
geddy jake routes[user] Show all routes for the user resource
geddy jake routes[user.index] Show the index route for the user resource
-------------------------------------------------------
Generator usage:
geddy gen [command] [options] [arguments]
Generator commands:
gen app <name> Create a new Geddy application
gen resource <name> [attrs] Create a new resource. A resource includes
a model, controller and route
gen scaffold <name> [attrs] Create a new scaffolding. Scaffolding includes
the views, a model, controller and route
gen secret Generate a new application secret in
`config/secret`
gen controller <name> Generate a new controller including an index view
and and a route
gen model <name> [attrs] Generate a new model
gen auth[:update] Creates user authentication for you, using Passport.
gen migration <name> Generate an empty migration file for SQL databases
Generator options:
--trace, -t Output detailed error information for failures
--realtime, -rt When generating or scaffolding, take realtime into account
--jade, -j When generating views this will create Jade
templates(Default: EJS)
--handle, -H When generating views this will create Handlebars
templates(Default: EJS)
--mustache, -m When generating views this will create Mustache
templates(Default: EJS)
--swig, -s When generating views this will create Swig
templates(Default: EJS)
Generator examples:
geddy gen app foo Generate an app in a directory named 'foo'
geddy gen resource user name admin:boolean
Generate a users resource with the model properties
name as a string and admin as a boolean
geddy gen scaffold user name:string:default
Generate a users scaffolding user name as the default
value to display data with