Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

read(1) for node.

tag: 0.0.1

Fetching latest commit…


Cannot retrieve the latest commit at this time

Octocat-spinner-32 example
Octocat-spinner-32 lib
Octocat-spinner-32 package.json

For reading user input from stdin.


var read = require("read")
read(options, callback)

The callback gets called with either the user input, or the default specified, or an error, in the traditional callback(error, result) node style.


Every option is optional.

  • prompt What to write to stdout before reading input.
  • silent Don't echo the output as the user types it.
  • num Max number of chars to read from terminal.
  • delim The char that means we're done. Default: "\n"
  • timeout Number of ms to wait for user input before giving up.

If silent is true, or num is set, or delim is something other than "\n", then read will set raw mode, and read character by character.

At this time, backspace and arrow keys are not supported in raw mode. It's probably not too hard to add support for this, perhaps using node's built-in readline module.


Patches welcome.

Something went wrong with that request. Please try again.