Skip to content
This repository

HTTPS clone URL

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
README.md

node-portfinder

Installation

Installing npm (node package manager)

  curl http://npmjs.org/install.sh | sh

Installing node-portfinder

  $ [sudo] npm install portfinder

Usage

The portfinder module has a simple interface:

  var portfinder = require('portfinder');

  portfinder.getPort(function (err, port) {
    //
    // `port` is guarenteed 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.