tsks-cli's Introduction

tsks

A stateful command line interface to help you handle your daily tsks (with synchronisation and contexts!).

Features

Add tsks, check what is already done and list active or archived tsks
Synchronise your tsks and access them from all your terminals! (soon accessible from a webapp as well)
Increase your daily tsks management with contexts using tsks add tsk --context=today (see tsks help add for more info)

Installation

gem install tsks

Usage

After follow the step above you should be able to run tsks from your terminal.

It's important to notice that you will need to run tsks init to setup stuffs like the storage before any other command.

Adding new tsks

tsks add "My first tsk"

Adding with context

tsks add "Bootstraps my pet project environment" --context=Today

Marking tsks as done

tsks done 2 # Where 2 is the tsk id

Listing your tsks

tsks list

Filtering by context

tsks list --context=Today

Or tsks already done

tsks list --done

Tip: It's possible to combine the flags --done and --context when listing.

Synchronising your tsks

Important!

Obs.: Until tsks-api is hosted somewhere, please download and run tsks-api then you will be able to use the commands below.

As easy as running tsks sync. This command will fetch your tsks from the API, then filter what is not synchronised yet from local, then update both remote and local tsks with most recent data.

To be able to sync you will need to login or register an account

Run this to login:

tsks login [email protected] --password=secret

Or this to register an account:

tsks register [email protected] --password=secret

Developing

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install (This command installs the current tsks version in your machine).

Releasing

./bin/release

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/luanrvmood/tsks.

Docs

https://gist.github.com/luanrv/cd580adf5be96d9d2eecd6add1733322

tsks-cli's People

Stargazers

Watchers

tsks-cli's Issues

Handle ECONNREFUSED error

An ECONNREFUSED error is triggered when the API host connection is lost.
Just run cp .env.sample .env and try some of the integrated commands login, register or sync to reproduce this.

Handle JSON::ParserError for unexpected responses from the API

Just run cp .env.sample .env and increment BASE_API_URI with some endpoint that does not exists.

Error:

JSON::ParserError: 783: unexpected token at ''
  /home/notinmood/.rvm/rubies/ruby-2.7.0/lib/ruby/2.7.0/json/common.rb:156:in `parse'
  /home/notinmood/.rvm/rubies/ruby-2.7.0/lib/ruby/2.7.0/json/common.rb:156:in `parse'
  /home/notinmood/tsks-cli/lib/tsks/request.rb:33:in `parse_response'
  /home/notinmood/tsks-cli/lib/tsks/request.rb:21:in `post'
  /home/notinmood/tsks-cli/lib/tsks/cli.rb:106:in `login'
  /home/notinmood/.rvm/gems/ruby-2.7.0/gems/thor-1.0.1/lib/thor/command.rb:27:in `run'
  /home/notinmood/.rvm/gems/ruby-2.7.0/gems/thor-1.0.1/lib/thor/invocation.rb:127:in `invoke_command'
  /home/notinmood/.rvm/gems/ruby-2.7.0/gems/thor-1.0.1/lib/thor.rb:392:in `dispatch'
  /home/notinmood/.rvm/gems/ruby-2.7.0/gems/thor-1.0.1/lib/thor/base.rb:485:in `start'
  /home/notinmood/tsks-cli/lib/tsks.rb:7:in `init'
  exe/tsks:5:in `<top (required)>'

Recommend Projects

luanrv / tsks-cli Goto Github PK