sails generate
Sails ships with several generators to help you scaffold new projects. You can also create your own generators to handle frequent tasks, or extend functionality (for example, by creating a generator that outputs view files for your favorite templating language).
The following generators are bundled with Sails:
sails generate new <appName>
Create a new Sails project in a folder called appName. See sails new for usage options.
sails generate api <foo>
Generate api/models/Foo.js and api/controllers/FooController.js
sails generate model <foo> [attribute1:type1, attribute2:type2 ... ]
Generate api/models/Foo.js, optionally include attributes with the specified types.
sails generate controller <foo> [action1, action2, ...]
Generate api/controllers/FooController.js, optionally include actions with the specified names.
sails generate adapter <foo>
Generate a api/adapters/foo folder containing the files necessary for building a new adapter.
sails generate generator <foo>
Generate a foo folder containing the files necessary for building a new generator.
Coffeescript support
If you want to use Coffeescript for write your controllers or models even config files; just follow these steps:
- Install Coffeescript locally and save it in your
package.jsonfile:npm install --save coffee-script - Install the generators for Coffeescript (optional):
npm install --save-dev sails-generate-controller-coffee sails-generate-model-coffee - To generate scaffold code, add
--coffee:sails generate api <foo> --coffee # Generate api/models/Foo.coffee and api/controllers/FooController.coffee sails generate model <foo> --coffee # Generate api/models/Foo.coffee sails generate controller <foo> --coffee # Generate api/controllers/FooController.coffee
Thats it, now you can write your code using Coffeescript!
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command Line Interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.