Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Failed to load latest commit information.
bin modified the path of node
config added the example configuration file
lib the module for searching tweets
.gitignore ignoring the configuration file
LICENSE initial commit
Makefile initial commit filled in the instructions for the readme
package.json filled in the details of the package


This is a sample command line application used in the JSReadme blog post. This cli app performs twitter search. This is meant to demonstrate how to build a cli app using Node.js.


Install the packages using NPM

npm install

Register for a Twitter app at Twitter Developers. Generate an access token for the app.

Once done, copy the configuration file to a new file called configuration.json

cp config/configuration.example.json config/configuration.json

Fill in the credentials on configuration.json.


Running with no arguments

Running without any arguments brings you to a prompt

node bin/birdie
prompt: query

Type in your search query and press enter. You should see the search results returned in JSON format.

Running with arguments

You can also pass in arguments. Arguments are assumed to be the query.

node bin/birdie foo

The search results for foo should return.

Running with options

You can change the results type of the results by passing in the r option.

node bin/birdie -r recent foo

Or the long option

node bin/birdie -resulttype recent foo

The r option takes in either mixed, recent or popular.

Something went wrong with that request. Please try again.