<commit_before># docli-rs (pronounced "dockly")

[![Build Status](https://travis-ci.org/kbknapp/docli-rs.svg?branch=master)](https://travis-ci.org/kbknapp/docli-rs) [![GitHub release](https://img.shields.io/github/release/kbknapp/docli-rs.svg)](https://github.com/kbknapp/docli-rs) [![GitHub license](https://img.shields.io/github/license/kbknapp/docli-rs.svg)](https://github.com/kbknapp/docli-rs/) [![Join the chat at https://gitter.im/kbknapp/docli-rs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kbknapp/docli-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A command-line utility for managing DigitalOcean infrastructure via the [DigitalOcean API v2](https://developers.digitalocean.com/documentation/) 

## Disclaimer
This library is in alpha - it may do anything up to, and including, eating your laundry. You can check the request being sent to DigitalOcean without sending via the `--nosend --verbose` flags

## Installation

### Linux / OSX

If you are on Arch linux, you can install from the AUR via the `docli-git` (requires a nightly Rust compiler). Otherwise you can try one of the pre-compiled binaries:

#### Linux x86_64

Assuming you're familiar `$PATH`, download the tar.gz, unzip, and copy to somewhere in your `$PATH`

```
$ wget http://wod.twentyfives.net/bin/docli/docli-v0.1.0-alpha2_linux-x64.tar.gz
$ tar xvf docli-v0.1.0-alpha2_linux-x64.tar.gz
$ cp docli ~/.bin
```
In the example `~/.bin` is in `$PATH`

#### OSX x86_64

Assuming you're familiar `$PATH`, download the tar.gz, unzip, and copy to somewhere in your `$PATH`

```
$ wget http://wod.twentyfives.net/bin/docli/docli-v0.1.0-alpha2_osx-x64.tar.gz
$ tar xvf docli-v0.1.0-alpha2_osx-x64.tar.gz
$ cp docli ~/.bin
```
In the example `~/.bin` is in `$PATH`

### Windows

I have not tried compiling on Windows yet. Feel free to clone the repository and attempt to compile with a nightly Rust compiler

## Compile from source

If you'd rather compile from source (takes about 2 minutes on a decent machine) use the following (Assuming you already have a nightly Rust compiler):

```
$ git clone https://github.com/kbknapp/docli-rs
$ cd docli-rs
$ cargo build --release
$ cp target/release/docli ~/.bin
```

## Usage

You can run `docli` from the command line and various subcommands. In order to see what commands are available, run `docli --help` or `docli <command> --help`

```
docli v0.1.0alpha
<NAME>. <<EMAIL>>
A utility for managing DigitalOcean infrastructure

USAGE:
    docli [FLAGS] [OPTIONS] [SUBCOMMANDS]

FLAGS:
    -h, --help       Prints help information
    -n, --nosend     Does NOT send request over the network (useful with --verbose)
        --version    Prints version information
    -v, --verbose    Displays the request being sent to server and JSON reply

OPTIONS:
    -t, --token <token>        Digital Ocean Auth Token (Defaults to contents of DO_AUTH_TOKEN env var if omitted)

SUBCOMMANDS:<commit_msg>chore: fix readme usage<commit_after># docli-rs (pronounced "dockly")

[![Build Status](https://travis-ci.org/kbknapp/docli-rs.svg?branch=master)](https://travis-ci.org/kbknapp/docli-rs) [![GitHub release](https://img.shields.io/github/release/kbknapp/docli-rs.svg)](https://github.com/kbknapp/docli-rs) [![GitHub license](https://img.shields.io/github/license/kbknapp/docli-rs.svg)](https://github.com/kbknapp/docli-rs/) [![Join the chat at https://gitter.im/kbknapp/docli-rs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kbknapp/docli-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A command-line utility for managing DigitalOcean infrastructure via the [DigitalOcean API v2](https://developers.digitalocean.com/documentation/) 

## Disclaimer
This library is in alpha - it may do anything up to, and including, eating your laundry. You can check the request being sent to DigitalOcean without sending via the `--nosend --verbose` flags

## Installation

### Linux / OSX

If you are on Arch linux, you can install from the AUR via the `docli-git` (requires a nightly Rust compiler). Otherwise you can try one of the pre-compiled binaries:

#### Linux x86_64

Assuming you're familiar `$PATH`, download the tar.gz, unzip, and copy to somewhere in your `$PATH`

```
$ wget http://wod.twentyfives.net/bin/docli/docli-v0.1.0-alpha2_linux-x64.tar.gz
$ tar xvf docli-v0.1.0-alpha2_linux-x64.tar.gz
$ cp docli ~/.bin
```
In the example `~/.bin` is in `$PATH`

#### OSX x86_64

Assuming you're familiar `$PATH`, download the tar.gz, unzip, and copy to somewhere in your `$PATH`

```
$ wget http://wod.twentyfives.net/bin/docli/docli-v0.1.0-alpha2_osx-x64.tar.gz
$ tar xvf docli-v0.1.0-alpha2_osx-x64.tar.gz
$ cp docli ~/.bin
```
In the example `~/.bin` is in `$PATH`

### Windows

I have not tried compiling on Windows yet. Feel free to clone the repository and attempt to compile with a nightly Rust compiler

## Compile from source

If you'd rather compile from source (takes about 2 minutes on a decent machine) use the following (Assuming you already have a nightly Rust compiler):

```
$ git clone https://github.com/kbknapp/docli-rs
$ cd docli-rs
$ cargo build --release
$ cp target/release/docli ~/.bin
```

## Usage

You can run `docli` from the command line and various subcommands. In order to see what commands are available, run `docli --help` or `docli <command> --help`

```
docli v0.1.0alpha2
<NAME>. <<EMAIL>>
A utility for managing DigitalOcean infrastructure

USAGE:
    docli [FLAGS] [OPTIONS] [SUBCOMMANDS]

FLAGS:
    -h, --help       Prints help information
    -n, --nosend     Does NOT send request over the network (useful with --verbose)
        --version    Prints version information
    -v, --verbose    Displays the request being sent to server and JSON reply

OPTIONS:
    -t, --token <token>        Digital Ocean Auth Token (Defaults to contents of DO_AUTH_TOKEN env var if omitted)

SUBCOMMANDS:
{'fraction_non_alphanumeric': 0.1303761173891044, 'fraction_numerical': 0.013324337999662674, 'mean_word_length': 4.008445945945946, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5023868', 'n_tokens_mistral': 2078, 'n_tokens_neox': 1997, 'n_words': 628}