Code Monkey home page Code Monkey logo

twit-cli's Introduction

version: 0.0.1

Note: This is the first version of twit-cli (duh), so at the moment you can only send tweets. Over the next coming weeks, many new features will be added. This means versions will be updated rapidly. Each new feature will be an uptick. So ready your npm update command! On with the README...

Intro

Do you love running applications from the command line? Do you love doing everything with your keyboard? I sure do! If you don't then this tool probably isn't for you. The twit-cli tool features all the great things you like to do on twitter, but in the comfort, love, and safety of your terminal.

Requirements

  • node js
  • npm
  • A twitter api account
  • A love for the terminal and cli tools

Getting started

Install

npm install twit-cli -g --production

Omit the --production flag if you would like to run tests.

Configuration

Create a .twit-cli dot file in your home directory with the following values that correspond to your Twitter application account. If you haven't created one yet, create it here. In order for twit-cli to work, you must set the application to read, write, and direct messages. Without that setting, twit-cli will fail to work and you will have to using Twitter from some application that is obviously inferior to cli.

Example:

{
	"consumer_key": "KEYZZZ",
	"consumer_secret": "SECRETZZZ",
	"access_token": "SECRET_KEYZZZZ",
	"access_token_secret": "SECRET_TOKENZZZ"
}

Command Reference

Getting started

Usage: twit-cli [options] [command]

  Commands:

    tweet [options] <status> 140 character message.

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -j, --json     Get response as JSON
    -v, --verbose  Verbose logging

Tweet

Usage: tweet [options] <status>

  Options:

    -h, --help     output usage information
    -j, --json     Get response as JSON
    -v, --verbose  Verbose logging
    -c, --count    Count characters in Tweet (will not send)

Tests

Test ensure command line args work and retrieve data. To run tests, clone this project and type npm test.

Contributers

Trevor Landau (Author)

Purpose

I created twit-cli mostly as an exercise to create a node.js cli tool, but also so I could tweet while in my terminal, because who doesn't want to do everything from the CLI.

twit-cli's People

Contributors

landau avatar jcrugzz avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

myok12

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.