sleek

❤️ Join the project and become a contributor

Join us in our mission to create a user-friendly, free, and open-source todo.txt client. We're actively inviting passionate contributors skilled in React, TypeScript, Electron, and Jest/Playwright to join our collaborative effort. The 2.x branch reflects the most recent progress, so feel free to fork it and dive into the exciting work ahead: https://github.com/users/ransome1/projects/3.

For those interested, we've updated our contribution guidelines, which you can find here: https://github.com/ransome1/sleek/blob/master/CONTRIBUTING.md. Your contributions will play a significant role in shaping the future of our project.

sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. It's available for Windows, MacOS and Linux

• Screenshots
• Development
• Support sleek
• Sponsor sleek
• Get it from Mac App Store
• Get it from Microsoft Store
• Get it from Snap Store
• Get it from Flathub
• Get it from Homebrew
• Get it from Arch User Repository
• Download it
• Build it from source code
• Features
• Used libraries

sleek is an open-source (FOSS) todo manager based on the todo.txt syntax. Stripped down to only the most necessary features, and with a clean and simple interface, sleek aims to help you focus on getting things done.

All classic todo.txt attributes are supported and enhanced by additional features. Creating todos is straightforward, and tag-based filtering in tandem with highly customisable grouping and smart full-text search allows for rapid information retrieval. Completed todos can be hidden or archived into separate done.txt files. Easy integration with other todo.txt apps is facilitated by continuously scanning todo.txt files for changes.

sleek is available for Windows, MacOS and Linux, and in several languages. For a detailed list of features, see below. Useful information can be found in sleek's wiki.

Screenshots

Support sleek

• Star, fork, and watch it on Github.
• Review it on the Mac App Store, SourceForge or the Windows Store
• Contribute to sleek

Sponsor sleek

Pushing sleek to the Apple and Microsoft app stores creates annual costs. You can cover these costs by sponsoring me.

Get sleek from Apple Mac App Store

Get sleek from Microsoft Store

Get sleek from Snap Store

Install sleek from Snap Store using: sudo snap install sleek

Get sleek from Flathub

Install sleek from Flathub using: flatpak install flathub com.github.ransome1.sleek

Run it using: flatpak run com.github.ransome1.sleek

Get sleek from Homebrew

Install sleek from Homebrew. brew install --cask sleek

Get sleek from Arch User Repository

Install sleek from AUR.

1. Setup Yay
2. yay -S sleek

Download sleek

You can download sleek for Windows, MacOS and Linux from

• SourceForge
• Github

Build sleek from source code

1. Setup Git, node.js and yarn.
2. Clone sleek git clone https://github.com/ransome1/sleek.git and cd into sleek's directory
3. Install dependencies yarn install --production
4. Build sleek yarn build:windows or yarn build:linux or yarn build:macos
5. The binaries will be placed in the working directory, in a subfolder named dist

Features

• Uses existing todo.txt files or creates new ones
• Add and search for todos by
  • priorities
  • contexts
  • projects
  • due dates
  • creation dates
  • recurrences (repeating todos)
  • threshold dates
• Sort and group todos by priority, due date, creation date, context, project, or as they occur in the text file
• Filter todos by context, project, and priority
• Find todos using full-text search compatible with todo.txt syntax
• Inline autocomplete available
• Dates and priorities can be selected by built-in picker elements
• Navigable via keyboard shortcuts
• Tabindex available
• Options for due date reminders and notification badges
• Easily toggle between dark and light mode
• Compact view and zoom available
• Completed todos can be shown, hidden, and archived
• Multiline todos can be created
• Filters are sorted alphanummerically and can be renamed or deleted
• Hyperlinks detected automatically
• File watcher scans todo.txt files for changes
• Simultaneously manage multiple todo.txt files
• Language options
  • English
  • German
  • Italian
  • Spanish
  • French
  • Simplified Chinese
  • Brazilian Portugese
  • Japanese
  • Turkish
  • Hungarian
  • Czech
  • Polish
  • Russian

A more detailed documentation can be found in sleek's wiki.

Used libraries

• Electron: https://github.com/electron/electron
• Electron builder: https://github.com/electron-userland/electron-builder
• Electron Notarize: https://github.com/electron/electron-notarize
• Electron Windows Badge: https://github.com/viktor-shmigol/electron-windows-badge
• electron-reloader: https://github.com/sindresorhus/electron-reloader
• Bulma CSS: https://github.com/jgthms/bulma
• Font Awesome: https://github.com/FortAwesome/Font-Awesome
• jsTodoTxt: https://github.com/jmhobbs/jsTodoTxt
• Marked: https://github.com/markedjs/marked
• vanillajs-datepicker: https://github.com/mymth/vanillajs-datepicker
• i18next: https://github.com/i18next/i18next
• i18next-fs-backend: https://github.com/i18next/i18next-fs-backend
• Matomo: https://github.com/matomo-org/matomo
• chokidar: https://github.com/paulmillr/chokidar
• Sugar: https://github.com/andrewplummer/Sugar
• PEG.js: https://github.com/pegjs/pegjs
• Playwright: https://github.com/microsoft/playwright
• Sass: https://github.com/sass/sass
• eslint: https://github.com/eslint/eslint