blew
Version:
A terminal tool to http://blew.io :3
93 lines (53 loc) • 3.33 kB
Markdown
[Vimia](http://github.com/vimia)/blew-cli
========
The [blew](http://github.com/vimia/blew) Command line Tool.
> ######:construction: Warning: DO NOT use in production.
> The project still under development, we hope to release a stable version soon.
### What ?
Well, [blew](http://github.com/vimia/blew) is a developers tool to share codes, and pastes, and blew-cli is the Command line tool helper to make easy to spread your snippets.
## :rocket: Getting Started
First of all, access blew.io, sign-up, and get your CLI Access Key¹²
* ¹ - You can find you Key at [CLI Page](http://blew.io/dashboard/getting-started)
* ² - Do NOT share your Access Key, it's our way to authenticate you!
### :electric_plug: Installing
We believe that you already installed [node], and [npm], so just:
```shell
$ sudo npm install blew -g
```
PS: This may take a while, depending on your computer and your network.
### :lock: Authentication
After installing our npm package, you need to copy your access key from our website, and run the command below:
```shell
$ blew auth -k YOUR_KEY
```
If everything works fine, you should expect something like this:
```shell
$ YOUR_NAME, thanks for use blew, your terminal is ready for use!
```
Otherwise [open an issue](https://github.com/vimia/blew-cli/issues/new) here with the problem, maybe a print or log.
### :fire: Usage
Now you're ready to go, so see below some usage examples:
##### Default usage:
```shell
$ blew new <file> <options>
```
#### Options grid
| Option | Description | Example |
| :-------------------------|:-----------------------------|:-------------------------------------------|
| -f / --file <file>¹ | File path/name | main.c or ../../core/main.py |
| -n / --name <name>² | Name for the paste | My_Paste, "My Code..." |
| -l / --language <language>| Language | JavaScript, JS, C, C++ ... |
| -p / --private³ | Is it Private? | Put -p only if it is private |
| -e / --expires | How long sould be available? | 1d (one day), 1m (one month), null (never) |
* ¹: Required Field;
* ²: If not fill, will have the same value as the file name;
* ³: No need to fill up true/false, if there's a -p will be private; The default value is false;
### :bar_chart: Badges
[](https://travis-ci.org/vimia/blew-cli) [](https://raw.githubusercontent.com/vimia/blew-cli/master/LICENSE) [](https://npmjs.org/package/blew)
[](http://waffle.io/vimia/blew-cli)
[](https://waffle.io/vimia/blew-cli/metrics)
### :octocat: Want to help ?
So you're a kickass developer?
Checkout our [issues](http://github.com/vimia/blew-cli/issues/) and help us out.
### :clap: We Use / Thanks to
* [Commander.js](https://github.com/visionmedia/commander.js/) - Command line tool creator for node;