sails new
Create a new Sails project.
sails new your-app-name
Usage:
Most Sails apps should be generated simply by running sails new your-app-name, without any additional customization. But sails new also accepts the following options:
--no-frontend: useful when generating a new Sails app that will not be used to serve any front-end assets. Disables the generation of theassets/folder,tasks/folder, and related files.--minimal: generates an extremely minimal Sails app. This disables the same things as--no-frontend, along with i18n, Waterline, Grunt, Lodash, Async, sessions, and views.--without: used to generate a Sails app without the specified feature(s). The supported "without" options are:'lodash','async','orm','sockets','grunt','i18n','session', and'views'. To disable multiple features at once, you can include the options as a comma-separated list, e.g.sails new your-app-name --without=grunt,views.
Example
To create a project called "test-project" in code/testProject/:
$ sails new code/testProject
info: Installing dependencies...
Press CTRL+C to skip.
(but if you do that, you'll need to cd in and run `npm install`)
info: Created a new Sails app `test-project`!
To create a Sails project in an existing myProject/ folder:
$ cd myProject
$ sails new .
info: Installing dependencies...
Press CTRL+C to skip.
(but if you do that, you'll need to cd in and run `npm install`)
info: Created a new Sails app `my-project`!
Creating a new Sails app in an existing folder will only work if the folder is empty.
Notes:
sails newis really just a special generator which runssails-generate-new. In other words, runningsails new foois an alias for runningsails generate new foo, and like any Sails generator, the actual generator module which gets run can be overridden in your global~/.sailsrcfile.
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.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- 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.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.