Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A simple tool to find an open port or domain socket on the current machine
branch: master

node-portfinder Build Status


Installing npm (node package manager)

  curl | sh

Installing node-portfinder

  $ [sudo] npm install portfinder


The portfinder module has a simple interface:

  var portfinder = require('portfinder');

  portfinder.getPort(function (err, port) {
    // `port` is guaranteed to be a free port
    // in this scope.

By default portfinder will start searching from 8000. To change this simply set portfinder.basePort.

Run Tests

  $ npm test

Author: Charlie Robbins

License: MIT/X11

Something went wrong with that request. Please try again.