Skip to content
the data logging engine behind
JavaScript Shell
Branch: master
Clone or download
Pull request Compare This branch is 56 commits behind sparkfun:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

phant Build Status

phant is a modular logging tool developed by SparkFun Electronics for collecting data from the Internet of Things. phant is the open source software that powers

If you would like to learn more about phant, please visit for usage & API docs.

Getting Started


Vagrant is a headless virtual machine that can be run on many different systems. Vagrant is a safe and easy way to run phant without the need to greatly modify your current system (see Why Vagrant?).

Vagrant Setup:

  1. Install VirtualBox
  2. Install Vagrant
  3. Install Git
  4. git clone
  5. cd phant && vagrant up --provision
  6. phant is now available via http on port 8080 and telnet via port 8081

To restart phant use vagrant provision from inside the phant directory.

To stop the vagrant virtual machine use vagrant halt from inside the phant directory.

To restart vagrant use vagrant up --provision from inside the phant directory.


phant is a npm package, and requires the latest version of node.js.

Once you have node.js installed, you can install phant by running npm install -g phant from your favorite terminal. Using the -g (global) flag will make the phant executable available in your PATH.

Now you can start phant:

$ phant
phant http server running on port 8080
phant telnet server running on port 8081

This launches a telnet server for stream creation, and a http server for data input & output. You can now open a separate window, and you should be able to create a stream by connecting to the local telnet server.

$ telnet localhost 8081
Connected to localhost.
Escape character is '^]'.
      __  /`     '.
   .-'  `/   (   a \
  /      (    \,_   \
 /|       '---` |\ =|
` \    /__.-/  /  | |
   |  / / \ \  \   \_\  jgs
   |__|_|  |_|__\
   never   forget.

Welcome to phant!
Type 'help' for a list of available commands



In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.


Copyright (c) 2014 SparkFun Electronics. Licensed under the GPL v3 license.

You can’t perform that action at this time.