Project

tsks

0.0
No release in over a year
A stateful command line interface to help you handle your daily tsks (with synchronisation and contexts)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

>= 0
>= 0
 Project Readme

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=sample@mail.com --password=secret

Or this to register an account:

tsks register --email=sample@mail.com --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