Skip to content

Latest commit

 

History

History
117 lines (76 loc) · 4.48 KB

README.md

File metadata and controls

117 lines (76 loc) · 4.48 KB
Raw

rChore Banner

release GitHub Workflow Status (branch) rust-version GitHub License PRs Welcome Twitter URL

rChore

A feature packed unofficial Google Tasks CLI to boost your producitvity, written purely in Rust.

🤔 What is rChore?

rChore is an unofficial Google Tasks CLI, it can help you manage various tasks right from your terminal, it also comes with a powerlevel10k battery support to boost your producivity!

Primary features of rChore are:

  • Single command login and logout
  • Auto obtain access token, login only once!
  • Create, Check, Update and Delete your tasks
  • Switch between task-lists and ability to create, update, and, delete task-lists.
  • p10k battery support that boosts your productivity!

💻 Usage

rChore Usage

  • After installing the binary, you can run it from anywhere by typing rchore
  • To get started with rChore, you need to login first, you can do this by typing rchore google login
  • A link will be prompt, copy it and open it in your browser, you will be redirected to Google login page.
  • You can then use the various commands to manage your tasks, for example rchore tasks list, rchore tasks add, rchore tasks done <task index>, rchore tasks delete <task index>
  • you can pass the -h flag to know more about a command, feel free to open an issue if you have any questions.

Powerlevel10k battery support

p10k demo

⬇ Installation

Cargo

If you have cargo installed, you can install rChore using cargo.

  • Few secret keys should be set via environment variables. To obtain GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET follow to: https://developers.google.com/tasks/firstapp#register. To set these variables you should add the following snippets (using your values for vars) to your ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish

bash / zsh:

export GOOGLE_CLIENT_ID=xxx
export GOOGLE_CLIENT_SECRET=yyy

fish:

set -gx GOOGLE_CLIENT_ID xxx
set -gx GOOGLE_CLIENT_SECRET yyy

  • Run . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish or restart your terminal emulator.

  • Run following install command.

cargo install rchore

Manual Installation

You can also download the binary and install it manually.

  • Go to releases page and grab the latest release of rChore.
  • Download the latest release of rChore specific to your OS.
  • If you are on Linux/MacOS, make sure you move the binary to somewhere in your $PATH (e.g. /usr/local/bin).

Powerlevel10k Battery Support

If you use powerlevel10k, you can type rchore battery to get help on installing the battery.

  • Open .p10k.zsh file in your favorite editor.

  • Copy the function from rchore battery and append it to your .p10k.zsh file

  • Add rchore to either POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS or POWERLEVEL9K_LEFT_PROMPT_ELEMENTS

      typeset -g POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(
  # =========================[ Line #1 ]=========================
  ...
  rchore
)

🛠 Architecture and Structure

rChore Architecture

⭐ Show your support

Give a ⭐ if you liked this project!

Spread the word to your fellows to boost producitivity for everyone!

🤝 Contributions

  • Feel Free to Open a PR/Issue for any feature or bug(s).
  • Make sure you follow the community guidelines and read CONTRIBUTING.md.md!
  • Feel free to open an issue to ask a question/discuss anything about rChore.
  • Have a feature request? Open an Issue!

⚖ License

Copyright 2021 Hemanth Krishna

Licensed under MIT License : https://opensource.org/licenses/MIT

Made with ❤ and multiple cups of coffee