5290charlie / todoist-linux

The Linux wrapper for Todoist web version

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Todoist Linux

This app is just an Electron wrapper for Todoist's web version.

This app works with both Windows and Linux.

Installation

Arch Linux (Thanks to HadiLatifi)

The package is available in AUR. You can install it with trizen -S todoist-electron

Other systems

  1. Go to Releases page and get the RPM/DEB/EXE package.

  2. Most of the time, a simple double-click on the downloaded package should start its installation (use shell commands otherwise).

Alternatively, you can also download the todoist-linux.zip package from Releases page that can run on any Linux distro.

Keyboard Shortcuts

  • Ctrl+Alt+A - Quickly add a Task

  • Ctrl+Alt+Q - Show or Hide Todoist window

  • Ctrl+Alt+R - Refresh Todoist window content

  • Alt+F4 - Quit Todoist

  • F11 - Toggle Full-screen view

  • Any other possible shortcuts are available and usable directly from within the app itself.

Global shortcuts are configurable via $XDG_CONFIG_HOME/.todoist-linux.json file (which is located in ~/.config by default). The file is simple JSON with descriptive keys and values that represents shortcuts and their keybindings.

Use this page from Electron docs to get a better understanding of what other modifiers (keys) exist that you can use.

Additional Configuration

Same config file .todoist-linux.json has other options to configure the app:

  • tray-icon - tray icon to use. Possible options: icon.png, icon_monochrome.png, null (to hide tray icon completely)

Why?

The main reason I don't like having the Todoist web version opened is that I can't easily ALT+TAB to it.

And I also really wanted to have global keyboard shortcuts so I can quickly add a task to Todoist.

The initial inspiration I took from this brilliant project of the same web version. Unfortunately, it doesn't seem to be maintained anymore and has some issues with Tray functionality on latest Ubuntu.

Build Instructions

The build process is very simple:

  1. Clone the repo using $ git clone https://github.com/krydos/todoist-linux.

  2. Ensure NPM is installed with $ apt-get install npm.

  3. Install other project dependencies by running $ make env in project root directory.

  4. Now, to run the app, you can do $ make up in the project root directory (or $ npm run start in the src directory).

Building Packages

After making your changes, you can simply use any of the below commands to build 64-bit distribution packages.

  1. Run $ make build-rpm to build .rpm packages (for Fedora/CentOS/RHEL/SuSE).
  2. Run $ make build-deb to build .deb packages (for Debian/Ubuntu and derivatives).
  3. Run $ make build-pacman to build .pacman packages (for Arch/Manjaro and derivatives).
  4. Run $ make build-win to build Windows .exe files.
  5. Run $ make build-linux to build both .DEB and .RPM packages.
  6. Run $ make build-all to build packages for both Windows and Linux (basically all the above).

Contributing

No rules for contributing. Just send a pull request :)

About

The Linux wrapper for Todoist web version

License:MIT License


Languages

Language:JavaScript 67.2%Language:Makefile 11.9%Language:HTML 9.8%Language:Shell 5.7%Language:CSS 5.4%