Skip to content

mejxe/habitcli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Command line tool to track your habits.

Built to use with Pixe.la, works best with premium.

Usage & Features

You can use a selection of commands to manipulate your pixela graphs.

data       Print your data
create     Creates a new graph on Pixela
remove     Removes a graph on Pixela
send       Use to send pixels to Pixela
get        Use to get pixels data from Pixela
list       List all graphs
streak     Calculates your current streak of consecutive pixels
setup-sum  Setup sum graph functionality
sum        Sums all progress of your graphs
help       Print this message or the help of the given subcommand(s)

Sum graphs

As of right now you can specify two graphs of which the progress will be summarized to a third graph. You set it all up using setup-sum then sum to push to the sum graph (third graph you specified).

While setting up sum graph functionality you will be asked for a number of sumgraphs you want to have. These sumgraphs can depend on many graphs now and it shouldn't really slow down the summing proccess because of async graph commit pulling.

However be wary about your amount of sum graphs, because they are summed in a blocking way. (sum graphs depending on other sum graphs would be impossible) After commiting all your progress to graphs simply run sum and it will sum up your graphs in a correct order. (if its possible)

Installation

Releases

This project uses cargo-dist for packing releases. Simply check out the newest release and follow the steps there.

Alternatively if you have cargo installed you can download it with cargo binstall

cargo binstall --git https://github.com/mejxe/habitcli

Cargo install

Pull and build with cargo.

cargo install --git https://github.com/mejxe/habitcli

Set up

If you have a pixela account: login <upixela username> <pixela api key/token> Your data will be stored in a private local database. If you don't have a pixela account you can create one using: signup <your api key/token> <desired username> <Agree to TOS [yes/no]> <Are you a minor? [yes/no]>

Contributing

The project is not perfect, nor perfectly tested. If you find a bug or would like to suggeset a new feature, please submit an Issue.

License

habitcli is licensed under MIT license.

About

cli for tracking habits using Pixe.la

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages