├── contributing.md └── README.md /contributing.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | Please ensure your pull request adheres to the following guidelines: 4 | 5 | - Search previous suggestions before making a new one, as yours may be a duplicate. 6 | - Suggested packages should be tested and documented. 7 | - Make an individual pull request for each suggestion. 8 | - Use the following format: `[package](link) - Description.` 9 | - Additions should be added to the bottom of the relevant category. 10 | - New categories, or improvements to the existing categorization are welcome. 11 | - Keep descriptions short and simple, but descriptive. 12 | - Don't mention `Vantage.js` in the description as it's implied. 13 | - Start the description with a capital and end with a full stop/period. 14 | - Check your spelling and grammar. 15 | - Make sure your text editor is set to remove trailing whitespace. 16 | - The pull request should have a useful title and include a link to the package and why it should be included. 17 | 18 | Thank you for your suggestions! 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome Vorpal [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) 2 | 3 | A curated list of delightful [Vorpal](https://github.com/dthree/vorpal)-based projects and extensions. 4 | 5 | [Vorpal is Node's first framework for building immersive CLI applications.](https://github.com/dthree/vorpal) 6 | 7 | Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing. 8 | 9 | ## Table of Contents 10 | 11 | - [Community](#community) 12 | - [Tutorials](#tutorials) 13 | - [Projects](#projects) 14 | - [Extensions](#extensions) 15 | - [Contribute](#contribute) 16 | - [License](#license) 17 | 18 | ## Community 19 | 20 | - [Chat](https://gitter.im/dthree/vorpal) 21 | - [Stack Overflow](http://stackoverflow.com/questions/tagged/vorpal.js) 22 | - [Wiki](https://github.com/dthree/vorpal/wiki) 23 | 24 | ## Tutorials 25 | 26 | - [By Brian Rinaldi] (http://developer.telerik.com/featured/creating-node-js-command-line-utilities-improve-workflow/) 27 | 28 | An excellent introduction to Vorpal, Brian Rinaldi from Telerik walks you through developing a sophisticated Vorpal app from scratch. 29 | 30 | - [By Ramon Gebben](http://daily-javascript.com/articles/vorpal/) 31 | 32 | A brief introduction to Vorpal by the author of [daily-javascript.com](daily-javascript.com). 33 | 34 | ## Projects 35 | 36 | *Awesome projects and applications built using Vorpal.* 37 | 38 | - [Cash](https://github.com/dthree/cash) - Cross-platform Linux commands without the suck. 39 | - [Raptor](https://developer.mozilla.org/en-US/Firefox_OS/Automated_testing/Raptor) - Performance testing CLI for Firefox developers. 40 | - [iTunes-remote](https://github.com/mischah/itunes-remote/) - Control iTunes on the CLI. 41 | - [phunt](https://github.com/Kristories/phunt) - Access [Product Hunt](https://www.producthunt.com/) on the CLI. *Trended on (you guessed it) Product Hunt.* 42 | - [trelew](https://github.com/websitesfortrello/trelew) - Access [Trello](https://trello.com/) on the CLI. 43 | - [wat](https://github.com/dthree/wat) - Community-built docs for every language, platform and library. 44 | - [metronome](https://github.com/AljoschaMeyer/metronome-cli) - A live metronome on the CLI. 45 | - [fastack](https://github.com/fastack/cli) - A zero-config tool that makes developing client-side apps easy. 46 | - [cbcluster](https://www.npmjs.com/package/cbcluster) - CLI for Couchbase Server Clusters. 47 | - [quotr](https://github.com/andrerpena/quotr) - View stock exchange quotes. 48 | - [Vantage](https://github.com/dthree/vantage) - `CLI` + `SSH` + `REPL` for your live Node app. 49 | - [birdknife](https://github.com/vanita5/birdknife) - A full featured [Twitter](https://twitter.com/) CLI. 50 | - [tv-remote-cli](https://github.com/Glavin001/tv-remote-cli) - CLI for remotely controlling your Smart TV. 51 | - [launch](https://github.com/NewSpring/meteor-launch) - Automating meteor builds to the AppStore, TestFlight, Hockey, Google Play, and more 52 | - [lifxsh](https://github.com/ristomatti/lifxsh) - Interactive shell for controlling [LIFX](http://www.lifx.com) smart lights. 53 | 54 | ## Extensions 55 | 56 | *Extensions add to the functionality of Vorpal - programmatically or live.* 57 | 58 | #### POSIX implementations 59 | 60 | - [less](https://github.com/vorpaljs/vorpal-less) - Implementation of the `less` command. 61 | - [grep](https://github.com/vorpaljs/vorpal-grep) - Implementation of the `grep` command. 62 | 63 | #### Development tools 64 | 65 | - [repl](https://github.com/vorpaljs/vorpal-repl) - Drops your CLI into a REPL within your app's context. 66 | - [tour](https://github.com/vorpaljs/vorpal-tour) - Build an interactive tour for your Vorpal app. 67 | - [watch](https://github.com/vantagejs/vantage-watch) - Updates your live Vorpal extensions in realtime. 68 | - [log](https://github.com/AljoschaMeyer/vorpal-log) - Advanced logging utility. 69 | - [set-or-print](https://github.com/AljoschaMeyer/vorpal-setorprint) - Easily set / get arguments with commands. 70 | 71 | #### Realtime 72 | 73 | - [use](https://github.com/vorpaljs/vorpal-use) - Import Vorpal extensions live: while your app is running. 74 | 75 | #### Fun 76 | 77 | - [hacker-news](https://github.com/vorpaljs/vorpal-hacker-news) - Pulls the top trending items from Hacker News. 78 | 79 | #### Toolbox 80 | - [rc](https://github.com/subk/vorpal-rc) - Simple .rc file support. 81 | - [comment](https://github.com/subk/vorpal-comment) - Bash-like comment support. 82 | - [as-default](https://github.com/ialpert/vorpal-as-default) - Triggers Vorpal task in case it runs without any specificly defined task. 83 | 84 | ## Contribute 85 | 86 | Contributions welcome! Read the [contribution guidelines](contributing.md) first. 87 | 88 | ## License 89 | 90 | [![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/) 91 | 92 | To the extent possible under law, [David Caccavella](https://github.com/dthree) has waived all copyright and related or neighboring rights to this work. 93 | --------------------------------------------------------------------------------