A Read-Eval-Print-Loop (REPL) is available both as a standalone program and\neasily includable in other programs. The REPL provides a way to interactively\nrun JavaScript and see the results. It can be used for debugging, testing, or\njust trying things out.\n\n
\nBy executing node without any arguments from the command-line you will be\ndropped into the REPL. It has simplistic emacs line-editing.\n\n
mjr:~$ node\nType '.help' for options.\n> a = [ 1, 2, 3];\n[ 1, 2, 3 ]\n> a.forEach(function (v) {\n... console.log(v);\n... });\n1\n2\n3For advanced line-editors, start Node.js with the environmental variable\nNODE_NO_READLINE=1. This will start the main and debugger REPL in canonical\nterminal settings which will allow you to use with rlwrap.\n\n
For example, you could add this to your bashrc file:\n\n
\nalias node="env NODE_NO_READLINE=1 rlwrap node"The built-in repl (invoked by running node or node -i) may be controlled\nvia the following environment variables:\n\n
NODE_REPL_HISTORY - When a valid path is given, persistent REPL history\nwill be saved to the specified file rather than .node_repl_history in the\nuser's home directory. Setting this value to "" will disable persistent\nREPL history.NODE_REPL_HISTORY_SIZE - defaults to 1000. Controls how many lines of\nhistory will be persisted if history is available. Must be a positive number.NODE_REPL_MODE - may be any of sloppy, strict, or magic. Defaults\nto magic, which will automatically run "strict mode only" statements in\nstrict mode.By default, the REPL will persist history between node REPL sessions by saving\nto a .node_repl_history file in the user's home directory. This can be\ndisabled by setting the environment variable NODE_REPL_HISTORY="".\n\n
Previously in Node.js/io.js v2.x, REPL history was controlled by using a\nNODE_REPL_HISTORY_FILE environment variable, and the history was saved in JSON\nformat. This variable has now been deprecated, and your REPL history will\nautomatically be converted to using plain text. The new file will be saved to\neither your home directory, or a directory defined by the NODE_REPL_HISTORY\nvariable, as documented below.\n\n
Inside the REPL, Control+D will exit. Multi-line expressions can be input.\nTab completion is supported for both global and local variables.\n\n
\nCore modules will be loaded on-demand into the environment. For example,\naccessing fs will require() the fs module as global.fs.\n\n
The special variable _ (underscore) contains the result of the last expression.\n\n
> [ 'a', 'b', 'c' ]\n[ 'a', 'b', 'c' ]\n> _.length\n3\n> _ += 1\n4The REPL provides access to any variables in the global scope. You can expose\na variable to the REPL explicitly by assigning it to the context object\nassociated with each REPLServer. For example:\n\n
// repl_test.js\nvar repl = require('repl'),\n msg = 'message';\n\nrepl.start('> ').context.m = msg;Things in the context object appear as local within the REPL:\n\n
mjr:~$ node repl_test.js\n> m\n'message'There are a few special REPL commands:\n\n
\n.break - While inputting a multi-line expression, sometimes you get lost\nor just don't care about completing it. .break will start over..clear - Resets the context object to an empty object and clears any\nmulti-line expression..exit - Close the I/O stream, which will cause the REPL to exit..help - Show this list of special commands..save - Save the current REPL session to a file\n\n.save ./file/to/save.js
\n
.load - Load a file into the current REPL session.\n\n.load ./file/to/load.js
\n
The following key combinations in the REPL have these special effects:\n\n
\n<ctrl>C - Similar to the .break keyword. Terminates the current\ncommand. Press twice on a blank line to forcibly exit.<ctrl>D - Similar to the .exit keyword.<tab> - Show both global and local(scope) variablesThe REPL module internally uses\n[util.inspect()][], when printing values. However, util.inspect delegates the\n call to the object's inspect() function, if it has one. You can read more\n about this delegation [here][].\n\n
For example, if you have defined an inspect() function on an object, like this:\n\n
> var obj = { foo: 'this will not show up in the inspect() output' };\nundefined\n> obj.inspect = function() {\n... return { bar: 'baz' };\n... };\n[Function]and try to print obj in REPL, it will invoke the custom inspect() function:\n\n
> obj\n{ bar: 'baz' }This inherits from [Readline Interface][] with the following events:\n\n
\n", "events": [ { "textRaw": "Event: 'exit'", "type": "event", "name": "exit", "desc": "function () {}\n\n
Emitted when the user exits the REPL in any of the defined ways. Namely, typing\n.exit at the repl, pressing Ctrl+C twice to signal SIGINT, or pressing Ctrl+D\nto signal 'end' on the input stream.\n\n
Example of listening for exit:\n\n
replServer.on('exit', function () {\n console.log('Got "exit" event from repl!');\n process.exit();\n});function (context) {}\n\n
Emitted when the REPL's context is reset. This happens when you type .clear.\nIf you start the repl with { useGlobal: true } then this event will never\nbe emitted.\n\n
Example of listening for reset:\n\n
// Extend the initial repl context.\nvar replServer = repl.start({ options ... });\nsomeExtension.extend(r.context);\n\n// When a new context is created extend it as well.\nreplServer.on('reset', function (context) {\n console.log('repl has a new context');\n someExtension.extend(context);\n});Makes a command available in the REPL. The command is invoked by typing a .\nfollowed by the keyword. The cmd is an object with the following values:\n\n
help - help text to be displayed when .help is entered (Optional).action - a function to execute, potentially taking in a string argument,\nwhen the command is invoked, bound to the REPLServer instance (Required).If a function is provided instead of an object for cmd, it is treated as the\naction.\n\n
Example of defining a command:\n\n
\n// repl_test.js\nvar repl = require('repl');\n\nvar replServer = repl.start();\nreplServer.defineCommand('sayhello', {\n help: 'Say hello',\n action: function(name) {\n this.write('Hello, ' + name + '!\\n');\n this.displayPrompt();\n }\n});Example of invoking that command from the REPL:\n\n
\n> .sayhello Node.js User\nHello, Node.js User!Like [readline.prompt][] except also adding indents with ellipses when inside\nblocks. The preserveCursor argument is passed to [readline.prompt][]. This is\nused primarily with defineCommand. It's also used internally to render each\nprompt line.\n\n
Returns and starts a REPLServer instance, that inherits from\n[Readline Interface][]. Accepts an "options" Object that takes\nthe following values:\n\n
prompt - the prompt and stream for all I/O. Defaults to > .
input - the readable stream to listen to. Defaults to process.stdin.
output - the writable stream to write readline data to. Defaults to\nprocess.stdout.
terminal - pass true if the stream should be treated like a TTY, and\nhave ANSI/VT100 escape codes written to it. Defaults to checking isTTY\non the output stream upon instantiation.
eval - function that will be used to eval each given line. Defaults to\nan async wrapper for eval(). See below for an example of a custom eval.
useColors - a boolean which specifies whether or not the writer function\nshould output colors. If a different writer function is set then this does\nnothing. Defaults to the repl's terminal value.
useGlobal - if set to true, then the repl will use the global object,\ninstead of running scripts in a separate context. Defaults to false.
ignoreUndefined - if set to true, then the repl will not output the\nreturn value of command if it's undefined. Defaults to false.
writer - the function to invoke for each command that gets evaluated which\nreturns the formatting (including coloring) to display. Defaults to\nutil.inspect.
replMode - controls whether the repl runs all commands in strict mode,\ndefault mode, or a hybrid mode ("magic" mode.) Acceptable values are:
repl.REPL_MODE_SLOPPY - run commands in sloppy mode.repl.REPL_MODE_STRICT - run commands in strict mode. This is equivalent to\nprefacing every repl statement with 'use strict'.repl.REPL_MODE_MAGIC - attempt to run commands in default mode. If they\nfail to parse, re-try in strict mode.You can use your own eval function if it has following signature:\n\n
function eval(cmd, context, filename, callback) {\n callback(null, result);\n}On tab completion - eval will be called with .scope as an input string. It\nis expected to return an array of scope names to be used for the auto-completion.\n\n
Multiple REPLs may be started against the same running instance of Node.js. Each\nwill share the same global object but will have unique I/O.\n\n
\nHere is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:\n\n
\nvar net = require('net'),\n repl = require('repl'),\n connections = 0;\n\nrepl.start({\n prompt: 'Node.js via stdin> ',\n input: process.stdin,\n output: process.stdout\n});\n\nnet.createServer(function (socket) {\n connections += 1;\n repl.start({\n prompt: 'Node.js via Unix socket> ',\n input: socket,\n output: socket\n }).on('exit', function() {\n socket.end();\n })\n}).listen('/tmp/node-repl-sock');\n\nnet.createServer(function (socket) {\n connections += 1;\n repl.start({\n prompt: 'Node.js via TCP socket> ',\n input: socket,\n output: socket\n }).on('exit', function() {\n socket.end();\n });\n}).listen(5001);Running this program from the command line will start a REPL on stdin. Other\nREPL clients may connect through the Unix socket or TCP socket. telnet is useful\nfor connecting to TCP sockets, and socat can be used to connect to both Unix and\nTCP sockets.\n\n
By starting a REPL from a Unix socket-based server instead of stdin, you can\nconnect to a long-running Node.js process without restarting it.\n\n
\nFor an example of running a "full-featured" (terminal) REPL over\na net.Server and net.Socket instance, see: https://gist.github.com/2209310\n\n
For an example of running a REPL instance over curl(1),\nsee: https://gist.github.com/2053342\n\n