Sha256: c9412e2a194f588d34db89d665ade17fbd40299003662592f08379b32a8a20d1

Contents?: true

Size: 1.31 KB

Versions: 3

Compression:

Stored size: 1.31 KB

Contents

habitica-cli [![Build Status](https://travis-ci.org/NickTomlin/habitica-cli-ruby.png?branch=master)](https://travis-ci.org/NickTomlin/habitica-cli-ruby) [![Gem Version](https://badge.fury.io/rb/habitica_cli.svg)](https://badge.fury.io/rb/habitica_cli)
===

A command line interface for habitica

## Installation

    $ gem install habitica_cli

## Usage

The cli needs your habitica user id and api key. You can configure these via the following:

- Setting/Exporting `HABIT_USER` and `HABIT_KEY` in your environment
- Using the `--habit-user` and `--habit-key` flags e.g. `habitica list --habit-user='user-id' --habit-key='user-api-key'`
- Creating a YAML file with `habit_user: <your user id>` and `habit_key: <your key>` at:
  - osx: `~/Library/Preferencs/habitica_cli-ruby/config.yml`
  - nix: `~/.config/habitica_cli-ruby/config.yml`
  - windows: `~\AppData\Local\Config\habitica_cli-ruby\config.yml`

```shell
habitica <command> <action>
```

## Contributing

```
bundle
# lint and run specs
rake

# run specs
rake spec

# lint
rake rubocop
```

1. Fork it ( https://github.com/[my-github-username]/habitica-cli/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
habitica_cli-1.0.2 README.md
habitica_cli-1.0.1 README.md
habitica_cli-1.0.0 README.md