sails console
Quietly lift your sails app (i.e. with logging silenced), and enter the node REPL. This means you can access and use all of your models, services, configuration, and much more. Useful for trying out Waterline queries, quickly managing your data, and checking out your project's runtime configuration.
Example
$ sails console
info: Starting app in interactive mode...
info: Welcome to the Sails console.
info: ( to exit, type <CTRL>+<C> )
sails>
Note that
sails consolestill lifts the server, so your routes will be accessible via HTTP and sockets (e.g. in a browser.)
Global variables in sails console
Sails exposes the same global variables in the REPL as it does in your app code. This is particularly useful in the REPL. By default, you have access to the sails app instance, your models, and your services; as well as lodash (sails.util._) and async (async).
Warning
Avoid using
_as a variable name in the Node REPL. (It doesn't work quite like you might expect-- although that is improving in Node v6.)Instead, use Sails' version of lodash as
sails.util._. For example:sails> sails.util._.keys(sails.config)Or alternatively, build yourself a local variable to use for familiarity:
sails> var lodash = sails.util._; sails> lodash.keys(sails.config);Finally, note that this warning isn't limited to the
_exposed by Sails as a global variable. When in the REPL, it's best to avoid usingvar _ = ...for any reason (again, unless you're running Node v6.0 or later.)
More Examples
Waterline
The format Model.action(query).exec(console.log) console.log is good for seeing the results.
sails> User.create({name: 'Brian', password: 'sailsRules'}).exec(console.log)
undefined
sails> null { name: 'Brian',
password: 'sailsRules',
createdAt: "2014-08-07T04:29:21.447Z",
updatedAt: "2014-08-07T04:29:21.447Z",
id: 1 }
Pretty cool, it inserts it into the database. However, you might be noticing the undefined and null. Don't worry about those. Remember that the .exec() returns error and data for values. So doing .exec(console.log) is the same as doing .exec(console.log(err, data))` The second method will remove the undefined message, but add null on a new line. It's up to you if you want to type more.
Exposing Sails
In sails console, type in sails to view a list of sails properties. You can use this to learn more about sails, override properties, or check to see if you disabled globals.
sails> sails
|> [a lifted Sails app on port 1337]
\___/ For help, see: http://sailsjs.com/documentation/concepts/
Tip: Use `sails.config` to access your app's runtime configuration.
1 Models:
User
1 Controllers:
UserController
20 Hooks:
moduleloader,logger,request,orm,views,blueprints,responses,controllers,sockets,p
ubsub,policies,services,csrf,cors,i18n,userconfig,session,grunt,http,projecthooks
sails>
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.