Back
gh

super-productivity/super-productivity: Super Productivity is an advanced todo list app with integrated Timeboxing and time tracking capabilities. It also comes with integrations for Jira, GitLab, GitHub and Open Project.

Super Productivity is an advanced todo list app with integrated Timeboxing and time tracking capabilities. It also comes with integrations for Jira, GitLab, GitHub and Open Project. - super-productivity/super-productivity

by super-productivity github.com 2,292 words
View original

Banner

An advanced todo list app with timeboxing & time tracking capabilities that supports importing tasks from your calendar, Jira, GitHub and others

🌐 Open Web App or 💻 Download

MIT license GitHub All Releases Chocolatey package On product hunt

Reddit Community Super Productivity on Mastodon Tweet

animated

Get it on Flathub Get it from the Snap Store English badge Obtanium Badge

Play Store Badge F-Droid Badge App Store Badge


Ukraine Flag
Humanitarian Aid for Ukraine
Support humanitarian relief via the official National Bank of Ukraine account.


✔️ Features

And much more!

Work View with global links

❓ How to use it

If you need some help, this article on dev.to is the best place to start.

If you prefer, there is also a (long) YouTube video available.

There is another older – the app looks and feels much better now;) – article on how I personally might use the app - and still another one on how I implement the ‘eat the frog’ prioritizing scheme in the app.

If you have further questions, please refer to the discussions page.

⌨ Keyboard shortcuts and short-syntax

Keyboard shortcuts (most important)

Short-Syntax

Can be used when adding a task. (Each of these can be disabled in settings->short syntax)

🌐 Web Version

Check out the web version even though it is a bit limited: Time tracking only works if the app is open and for idle time tracking to work, the chrome extension must be installed.

If you want the Jira integration and idle time tracking to work, you also have to download and install the Super Productivity Chrome Extension.

💻 Downloads & Install

All Platforms

Install from the releases page.

Windows

Due to certification issues it’s recommended to download the app from the Microsoft Store:

English badge

You can also install the app using Chocolatey:

choco install super-productivity

or using Scoop:

scoop install extras/super-productivity

Linux

Snap - Most distributions

Get it from the Snap Store

Install via command-line:

# stable
sudo snap install superproductivity

# edge channel releases
sudo snap install --channel=edge superproductivity

# it is also recommended to disable updates to the app while it is running:
sudo snap set core experimental.refresh-app-awareness=true

Important: Enable Local File Sync To use local file sync, you need to manually connect the home interface:

sudo snap connect superproductivity:home

⚠️ Snap Data Persistence Warning When uninstalling the snap package, all user data (tasks, projects, settings) stored in ~/snap/superproductivity/common/ may be removed. Always export your data before uninstalling. Consider using Flatpak, AppImage, or.deb packages if you prefer data to persist in the standard ~/.config/ location.

For more details, see issue #6031.

Flatpak - Most distributions

Get it on Flathub

Must install Flatpak first. See setup instructions for all distributions.

Install via command-line:

# install
flatpak install flathub com.super_productivity.SuperProductivity

# run
flatpak run com.super_productivity.SuperProductivity

AUR - Arch Linux

AppImage

If you encounter problems, please have a look here: #3193 (comment)

MacOS

App Store Badge

Install via homebrew cask:

brew install --cask superproductivity

Android

Play Store Badge F-Droid Badge

A new version of the Android app is now available with Connectivity-Free Mode, allowing you to use the app without an internet connection.

This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you’re online or offline.

Stay tuned for even more exciting updates!

The sources can be found here.

Community

The development of Super Productivity is driven by a wonderful community of users and contributors. Thank you all so much for your support!

👀 Check out our awesome curated list of community-created resources about Super Productivity

♥️ Contributing

If you want to get involved, please check out the CONTRIBUTING.md

There are several ways to help.

  1. Spread the word: More users mean more people testing and contributing to the app which in turn means better stability and possibly more and better features. You can vote for Super Productivity on Slant, Product Hunt, Softpedia or on AlternativeTo, you can tweet about it, share it on LinkedIn, reddit or any of your favorite social media platforms. Every little bit helps!
  2. Provide a Pull Request: Here is a list of the most popular community requests and here some info on how to run the development build. Please make sure that you’re following the commit message format and to also include the issue number in your commit message, if you’re fixing a particular issue (e.g.: feat: add nice feature #31).
  3. Answer questions: You know the answer to another user’s problem? Share your knowledge!
  4. Provide your opinion: Some community suggestions are controversial. Your input might be helpful and if it is just an up- or down-vote.
  5. Provide a more refined UI spec for existing feature requests
  6. Report bugs
  7. Make a feature or improvement request: Something can be done better? Something essential missing? Let us know!
  8. Translations, Icons, etc.: You don’t have to be a programmer to help. Some of the icons really need improvement and many of the translations could use some love.
  9. Sponsor the project
  10. Create custom plugins: Extend Super Productivity with your own features and integrations by developing custom plugins.

Special Thanks to our Sponsors!!!

Recently support for Super Productivity has been growing! A big thank you to all our sponsors, especially the ones below!

Code Signing

Windows binaries are signed. Free code signing is provided by SignPath.io, certificate by SignPath Foundation.

Running the development server

If you don’t want or cannot use Codespaces for any reason, here are the instructions for local development.

To run the development server you need to have Node installed (version 20 or higher required). Go to https://nodejs.org for installation instructions.

1. Clone repo

git clone https://github.com/super-productivity/super-productivity.git

2. Install dependencies

cd super-productivity
npm i -g @angular/cli
npm i
# prepare the env file once
npm run env

3. Run the dev server

ng serve

Afterwards you can open http://localhost:4200 in your browser. For most adjustments this should be enough and also enables you to use the Redux DevTools.

If you want to run the app standalone do the following:

ng serve

# in a new console tab
npm start

🚀 Try with GitHub Codespaces

You can develop and run Super Productivity instantly in your browser using GitHub Codespaces: no need to install Node.js or any dependencies locally. On the top of the repository page, click on “Code”, “Codespaces”, and then on the plus button, “Create Codespace”.

Your VS Code settings can sync as usual, so your environment feels just like home. The development server starts automatically, and the dev container auto-forwards the port. Open the “Ports” tab and Ctrl+Click the available link to preview your running Super Productivity app.

Further customizations to the Codespaces dev container can be performed by editing the.devcontainers/devcontainers.json file according to the Codespaces documentation and the devcontainers full specification.

Packaging the app

Packaging the app is done via electron-builder. To start packaging run npm run dist. If you want to add new platforms and experiment with the build options the easiest way to do so is manipulating the build property in the package.json, but you can also use the command line interface of electron builder.

Building for Android

This feature was added on October 7, 2024. See Pull Request #57.

To build the Android version of Super Productivity, please refer to the Android Build Documentation, which includes instructions on configuring Connectivity-Free Mode and Online-Only Mode (Compatibility Mode).

Ensure you follow the setup steps properly to configure the environment for building the app.

Run as Docker Container

docker run -d -p 80:80 super-productivity/super-productivity:latest

[!note] Note The command will automatically pull the container that matches the host’s platform. Use --platform to specify a different one.

Currently supported architectures: linux/amd64, linux/arm64, linux/arm/v7.

Now you can access the web app from your browser at http://localhost.

This container only serves the web app, and the user data is stored in the browser. Therefore, it does not have any persistent storage.

Integrate with WebDAV backend server

You can integrate the container with a WebDAV server container to provide WebDAV service with base url http://localhost/webdav.

Download pre-configured files

Download the pre-configured docker-compose.yaml and webdav.yaml from this repository to a local directory, say sp/.

# Alternatively, you can get them by cloning this repository
git clone https://github.com/super-productivity/super-productivity.git
mkdir -p sp
cp super-productivity/docker-compose.yaml sp/
cp super-productivity/webdav.yaml sp/
cd sp

Setup user accounts

Edit webdav.yaml to configure username and password. Remember to create and assign different directories to different users (within /data) to avoid mixing up user data.

Start the services

docker compose pull
docker compose up -d

Additionally to accessing the web app from your browser at http://localhost, you can set up WebDAV synchronization with base url http://localhost/webdav/.

Other configuration of docker container

You can provide the default values for WebDAV settings in the “Sync” section of the “Settings” page, via setting some environment variables of the docker container. This could be used for single user instances. Check out docker-compose.yaml in this repository for available environment variables.

Custom themes (desktop only)

The app ships with several built-in themes (Arc, Catppuccin Mocha, Cyberpunk, Dark Base, Dracula, Everforest, Glass, Nord Polar Night, Nord Snow Storm, Rainbow) that you can select from the settings. You can also color-code individual projects and tags with custom primary, accent, and warn colors.

In addition, you can load completely custom CSS to restyle everything. To load a custom theme, simply put your styles into a new file named styles.css directly in the user data folder. Your custom CSS will override the default styles, giving you full control over the app’s appearance.

Custom WebDAV Syncing

If using the integrated WebDAV Syncing is not working out for you, you can also try to sync all app files, which are located in the user data folder.

Automatic Backups

For the desktop version automatic backups are stored by default in the backup subfolder of the user data folder. Once you locate a backup, you can restore it on the settings page under Sync & Export/Import/Export/Import from file.

User Data Folder

Where user data is stored differs from OS to OS. The most common locations are:

OSLocation
Mac OS~/Library/Application Support/superProductivity/
WindowsC:\Users\<YOUR_USER_NAME>\AppData\Roaming\superProductivity/ or %APPDATA%\superProductivity
Linux~/.config/superProductivity/

The path should be shown when you go to the “Automatic Backups” section on the configuration page (minus the “backup” subfolder). You can also see it printed out when you start the app from the command line.

For web browsers, data is simply stored for the current user inside the browser storage.

Using a custom folder to save user data

You can specify a custom folder for saving your data by starting the application with the --user-data-dir parameter like so:

superproductivity --user-data-dir=/path/to/my/data

Linux/Wayland Compatibility

If you’re experiencing issues running Super Productivity on Wayland (such as rendering problems, VSync errors, or GLib-GObject warnings), you can force the application to use X11 mode by starting it with the --force-x11 parameter:

superproductivity --force-x11

This will automatically apply compatibility fixes including:

The application will automatically detect Wayland sessions and apply these fixes, but you can use this flag if automatic detection doesn’t work properly.