View our GitHub

Please visit sails-docs on GitHub to view documentation on your mobile device.

Edit Page

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.


$ sails console

info: Starting app in interactive mode...

info: Welcome to the Sails console.
info: ( to exit, type <CTRL>+<C> )


Note that sails console still 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 console 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 Lo-Dash (sails.util._) and async (async).


Be careful when using _ as a variable name in the Node REPL- and when possible, don't. (It doesn't work quite like you'd expect.)

Instead, use lodash as sails.util._, e.g.:

sails> sails.util._.keys(sails.config)

Or alternatively, build yourself a local variable to use for familiarity:

sails> var lodash = _;

Then you can do:

sails> lodash.keys(sails.config);

More Examples


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)
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:

Tip: Use `sails.config` to access your app's runtime configuration.

1 Models:

1 Controllers:

20 Hooks:


Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.


We wrote a book!

Get early access to the book
with promotion code: mcneildoc

Get the Book