README - Super Productivity

<div style="height:20px;"></div> <p align="center"> <strong> An advanced todo list app with timeboxing & time tracking capabilities that supports importing tasks from your calendar, Jira, GitHub and others </strong> <p> <p align="center"> :globe_with_meridians: <a href="https://app.super-productivity.com">Open Web App</a> or :computer: <a href="https://github.com/super-productivity/super-productivity/wiki/2.01-Downloads-and-Install">Download</a> </p>  <p align="center"> <a href="https://lbesson.mit-license.org"></a>   <a href="https://github.com/super-productivity/super-productivity/discussions"></a> </p> <p align="center"> <a href="https://www.reddit.com/r/superProductivity/"></a>   <a href="https://mastodon.social/@superproductivity"></a>   <a href="https://x.com/intent/post?text=Super%20Productivity%20%20https%3A%2F%2Fsuper-productivity.com"></a> </p> <p align="center"> <a href="https://youtu.be/_mvMXWLsL-8"></a> </p>

:computer: Downloads & Install

<p align="center"> <a href='https://flathub.org/apps/com.super_productivity.SuperProductivity' target="_blank"> </a> <a href="https://snapcraft.io/superproductivity" target="_blank"></a> <a href='//www.microsoft.com/store/apps/9NHFVG8361TW?cid=storebadge&ocid=badge' target="_blank"></a> <a href='//play.google.com/store/apps/details?id=com.superproductivity.superproductivity' target="_blank"></a> <a href='//f-droid.org/en/packages/com.superproductivity.superproductivity' target="_blank"></a> <a href='http://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/super-productivity/super-productivity/releases'></a> <a href='//apps.apple.com/app/super-productivity/id1482572463?l=en' target="_blank"></a> </p> <p align="center"> <strong>For all current downloads, package links, and platform-specific notes: <a href="https://github.com/super-productivity/super-productivity/wiki/2.01-Downloads-and-Install" target="_blank"> check the wiki</strong>. </a> </p> <hr> <div style="height:20px;"></div> <p align="center"> <a href="https://bank.gov.ua/en/news/all/natsionalniy-bank-vidkriv-rahunok-dlya-gumanitarnoyi-dopomogi-ukrayintsyam-postrajdalim-vid-rosiyskoyi-agresiyi" target="_blank">

<strong>Humanitarian Aid for Ukraine</strong>

Support humanitarian relief via the official National Bank of Ukraine account.

</a> </p> <hr>

:heavy_check_mark: Features

Keep organized and focused! Plan and categorize your tasks using sub-tasks, projects and tags and color code them as needed.
Use timeboxing and track your time. Create time sheets and work summaries in a breeze to easily export them to your company's time tracking system.
Helps you to establish healthy & productive habits:
- A break reminder reminds you when it's time to step away.
- The anti-procrastination feature helps you gain perspective when you really need to.
- Need some extra focus? A Pomodoro timer is also always at hand.
- Collect personal metrics to see, which of your work routines need adjustments.
Integrate with Jira, Trello, GitHub, GitLab, Gitea, OpenProject, Linear, ClickUp and Azure DevOps. Auto import tasks assigned to you, plan the details locally, automatically create work logs, and get notified immediately, when something changes.
Basic CalDAV integration.
Back up and synchronize your data across multiple devices with Dropbox and WebDAV support
Attach context information to tasks and projects. Create notes, attach files or create project-level bookmarks for links, files, and even commands.
Super Productivity respects your privacy and does NOT collect any data and there are no user accounts or registration. You decide where you store your data!
It's free and open source and always will be.

And much more!

[!NOTE] The web version has some limitations: See the Web App vs Desktop comparison for more details.

:book: Documentation and Guides

<div style="display: flex; gap: 30px; align-items: flex-start;">  <div style="flex: 1;"> <h3>Getting Started</h3> <ul> <li><a href="https://dev.to/johannesjo/getting-started-with-super-productivity-2791">Getting started guide</a> (article)</li> <li><a href="https://www.youtube.com/watch?v=VoF2_RSdNXA">Video walkthrough</a> (YouTube)</li> <li><a href="https://dev.to/johannesjo/the-prioritising-scheme-how-to-eat-the-frog-with-super-productivity-mlk">Eat the frog prioritizing scheme</a></li> </ul> <p><strong>Starting Point in Wiki:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/1.01-First-Steps">First steps</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.00-Reference">Reference</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/2.00-How_To">How-To</a>
</p>
<p><strong>Productivity Tips:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/3.03-Keyboard-Shortcuts">Keyboard Shortcuts</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.04-Short-Syntax">Short Syntax</a>
</p>
<p><strong>Need Help?</strong>

  <a href="https://github.com/super-productivity/super-productivity/discussions">Visit the discussions page</a>
</p>
<p>See the bottom of the README for more information on the documentation.</p>

</div>  <div style="flex: 1;"> <h3>Advanced Topics</h3> <p>Here are some other topics covered in the <a href="https://github.com/super-productivity/super-productivity/wiki">official wiki</a>: </p> <p><strong>Development:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/2.11-Run-the-Development-Server">Run dev server</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/2.12-Package-the-App">Package the app</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/2.14-Build-for-Android">Build for Android</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/2.13-Run-with-Docker">Run with Docker</a>
</p>
<p><strong>Data Management:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/4.23-Managing-Your-Data">User Data</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.07-Issue-Integration-Comparison">Issue Providers</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.08-Sync-Integration-Comparison">Sync Providers</a>
</p>
<p><strong>Customization:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/2.15-Develop-a-Plugin">Plugins</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.09-Theming">Themes</a>
</p>
<p><strong>APIs:</strong>

  <a href="https://github.com/super-productivity/super-productivity/wiki/3.01-API#1-sync-server-rest-api">Sync Server</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.01-API#2-plugin-api">Plugins</a> •
  <a href="https://github.com/super-productivity/super-productivity/wiki/3.01-API#3-local-rest-api">REST</a>
</p>

</div> </div>

Community

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

<p> :eyes: <a href='https://github.com/super-productivity/awesome-super-productivity'> Check out our awesome curated list of community-created resources about Super Productivity </a> </p>

:hearts: Contributing

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

There are several ways to help.

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!
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 (wiki). 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).
Answer questions: You know the answer to another user's problem? Share your knowledge!
Provide your opinion: Some community suggestions are controversial. Your input might be helpful and if it is just an up- or down-vote.
Provide a more refined UI spec for existing feature requests
Report bugs
Make a feature or improvement request: Something can be done better? Something essential missing? Let us know!
Translations, Icons, etc.: You don't have to be a programmer to help; learn how to contribute translations!

Sponsor the project
Create custom plugins or custom themes

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!

<p> Agentic AI Quality Engineering via:  <a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=superproductivity" target="_blank"> <picture> <source srcset="https://super-productivity.com/_astro/test-mu-log-dark.Dy0yXuJ7.svg" media="(prefers-color-scheme: dark)" />
```
  </picture>
</a>
```
</p>

(If you are, intend to or have been a sponsor and want to be shown here, please let me know!)

Code Signing

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

Documentation: Manual versus Automated

There are two wikis: the official one hosted in by GitHub autonomously generated variant using DeepWiki.com. The manually curated version is a more stable and approachable resource designed to help you understand the app from a more human-focused perspective whereas DeepWiki is optimized for explaining the code itself with little regard for context beyond that.

<div style="display: flex; gap: 10px; align-items: flex-start;">  <div style="flex: 1;"> <h3>Official Wiki</h3> <p> It is preferable to maintain local documentation rather than rely on an external service. It also preferable that the documentation is updated in tandem with the code changes as demonstrated in <a href="https://github.com/super-productivity/super-productivity/commit/7a51d4b06e414fdcc48e4999197a93eee9cd09da">this commit</a>. </p> <p> Changes to files within <code>./docs/wiki</code> are linted in CI before being automatically sync'd to the repository's official Wiki hosted by GitHub. </p> <p> Migrating to Docusaurus is a long-term goal once the content and structure of the wiki has matured and the remaining "legacy docs" have either been reworked or removed. There are some automations in development to help reduce the difference between the published docs and the state of the code while retaining a human-in-the-loop. </p> </div>  <div style="flex: 1;"> <h3>DeepWiki.com</h3> <p> If you have very specific questions about how the code works or why a bug might be producing a particular message it might be useful to <a href="https://deepwiki.com/super-productivity/super-productivity">

  </a>. It can help "cite your sources" when discussing functionality and code that you don't fully
  understand as part of feature requests or bug reports.
</p>
<p>
  This automated
  <a href="https://diataxis.fr/reference/#reference">reference</a>
  does come with some significant drawbacks:
</p>
<ol>
  <li><strong>Intent:</strong> Describes what code does, not why decisions or tradeoffs were made.</li>
  <li><strong>Staleness:</strong> Will *always* lag behind the code.</li>
  <li><strong>Code-Focused:</strong> Does not provide guides or conceptual explanations.</li>
  <li><strong>Cost:</strong> Potential future cost and higher resource usage than static docs.</li>
</ol>

</div> </div>