Available generators
The Sails framework's built-in generators can be customized using command-line options and overridden by mounting custom generators in the .sailsrc file. Other generators that add completely new sub-commands to sails generate can be mounted in the same way.
Core generators
Certain generators are built in to Sails by default.
| Commands that generate a new Sails app |
|---|
| sails new name |
| sails new name --fast |
| sails new name --caviar |
| sails new name --without=grunt |
| sails new name --without=lodash,async,grunt,blueprints,i18n |
| sails new name --no-frontend --without=sockets,lodash |
| sails new name --minimal |
| Generators for spitting out new files in an existing Sails app |
|---|
| sails generate model identity |
| sails generate action name |
| sails generate action view-name |
| sails generate action _some/path/_view-name |
| sails generate page name |
| sails generate helper name |
| sails generate helper view-name |
| sails generate script name |
| sails generate script get-name |
| sails generate controller name |
| sails generate api name |
| sails generate hook name |
| sails generate response name |
| Commands for generating plugins |
|---|
| sails generate generator name |
| sails generate adapter name |
| Commands for (re)generating client-side dependencies |
|---|
| sails generate sails.io.js |
| sails generate parasails |
| Utils for building your own 3rd party packages |
|---|
| sails generate etc |
Since Sails v1.0, built-in generators are now bundled in Sails core, rather than in separate NPM packages. All generators can still be overridden the same way. For advice setting up overrides for core generators in your environment, click here.
Community generators
There are over 100 community-supported generators available on NPM:
- sails-inverse-model
- sails-generate-new-gulp
- sails-generate-archive
- sails-generate-scaffold
- sails-generate-directive
- sails-generate-bower
- sails-generate-angular-gulp
- sails-generate-ember-blueprints
- And many more...
For a better experience on sailsjs.com, update your browser.
Concepts
Built with Love
The Sails framework is built by a web & mobile shop 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-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.