Code Monkey home page Code Monkey logo

keyclucask's Introduction

KeyClu for macOS

Simple and handy overview of applications shortcuts. Easy to use: just press twice and hold to see the list.

platform:macos  + Intel version:bigsur category:productivity license:bsd-3-clause-clear

github downloads brew downloads

Screenshots

screenshot1

screenshot2

screenshot3

Installation

Homebrew

To install it using Homebrew, open the Terminal app and type:

brew install --cask keyclu

Manual

Download the latest version .dmg, open it and move the KeyClu app to the Applications folder.

Permissions

  • Required access to Accessibility API to operate.
  • Preferred to have access to Notification Center to provide gentle update notification.

Basic usage

  • Press key twice and hold (default) to present shortcuts of current app
  • Press key and hold (alternative) to present shortcuts of current app

Features

A few of the things you can do with KeyClu:

  • Adjust view to your liking
  • Personalize appearance to system, light and dark
  • Bookmark shortcuts
  • Hide known shortcuts
  • List own & skhd shortcuts
  • Filter and hightlight shortcuts
  • Export App's shortcuts to markdown file

Integrations

FAQ

How to open Settings if icon is hidden?

To open Settings simply launch app again.

App just crashed!

In case of a crash, please open the issue and provide details, relevant logs, and a brief description of your activities that might leading up to the crash. Check the page FAQ - KeyClu just crashed for guidance on collecting the necessary information for the issue. Your cooperation will help to resolve issue more effectively.

Roadmap

Take a look at KeyClu's Project board to get an idea of what's brewing!

Feature requests are always welcome.

Privacy Policy

KeyClu collects no personal information nor does use any services for analytics, advertising etc.

License & Credits

KeyClu is released under the BSD-3-Clause-Clear license. See LICENSE for details.

This software uses the following open source packages:

Thanks

  • Special thanks to everyone who contributed to getting the KeyClu to the current state
  • @wanwindwalker for legacy app icon

Support

If you ❤️ the KeyClu and found it useful for your tasks, be sure to ⭐ it and maybe support me with caffeine.

keyclucask's People

Contributors

anze avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

keyclucask's Issues

Persistent panel is randomly triggered

Description

Hi. I am using Karabiner and BetterTouchTool for keyboard shortcuts and sometimes the persistent panel is unintendedly opened. I have not found a particular key combination that reliably opens it but it happens clearly without the 3 key presses.
It had also happened to me with the shortcuts panel until setting the activation to pressing the command key twice.

Anyway, I'd suggest adding the option of triggering the panels with a freely chosen keyboard shortcut, to better integrate KeyClu to different scenarios.

Expected behavior

persistent panel only activate after pressing command key 3 times or with a eligible keyboard shortcut

App version

0.24

macOS version

macOS Sonoma 14.3.1

Installation method

Manual (dmg/zip)

Checklist before submitting a bug

[feature]: Show macros from Keyboard Maestro

Proposal

The idea is to display all macros defined with Keyboard Maestro if they have a shortcut.

Alternatives

KeyCue already will do the same thing for KeyboardMaestro macros.

Autoupdate

Make app checking by itself for new releases

Mouse-over element highlighting freezes

Normal behavior: When the main window is called up, moving the mouse cursor over the different shortcuts listed will cause each item to be highlighted while the cursor is hovering over it.

Wonky behavior: If, when the main window is called up, the cursor is already at a point on the screen such that the KeyClu window opening causes one of the shortcut list items to appear under the cursor arrow, then that item will be stuck permanently highlighted, even if the mouse cursor is moved away from that item or onto other items. This resets when the main window is dismissed.

Screen Shot 2023-09-26 at 1 28 46 p m Screen Shot 2023-09-26 at 1 28 59 p m

Crashes when using with Firefox

Just installed KeyCluCask and when trying to use in Firefox 120.0b3, it causes KeyClu and Firefox to stop responding. Once KeyClu is force quit Firefox becomes responsive again.

Running on Sonoma 14.0 (23A344)

Problems of Clicking to trigger.

Double press command and hold to open KeyClu dialog and do clicking via cursor would run into 2 problems.

  1. Clicking menu on KeyClu dialog to trigger shortcut key only works once, I must release command and double press and hold again to make it click-able via cursor again.
  2. Clicking only accepted while cursor hovering on menu or shortcut key's TEXT label, not working on SPACE in the middle.

KeyClu v0.18
MacBook Pro M2 Pro
macOS 14.2.1

keyclu wont launch at login

Hi there,
I have a problem, in keyclu setting the launch at login option is on, and even if i add keyclue to the launch at login in the system preference of my mac, after rebooting my mac it won't launch and keyclu is deleted from the list in my system preferences.
Any idea what's up ?

Lots of empty space with only few entries

If there aren't a lot of entries present the window looks visually unbalanced with all the empty space in the lower half:

IMG_7178

I think the amount of columns and window width/height should be dynamic based on the amount of content to avoid empty space.

does not work if sticky keys is enabled

I can't open the cheat shit by double clicking and holding "command" if i have sticky keys enabled. how can i use this app while maintaining sticky keys active?

Function Keys like F13-F19 are not supported in My Shortcuts

I have a magic keyboard (the previous generation without touch ID), and have set up several hot keys with under-utilized functions keys like F16.
It seems that keyclu can detect the key press in My Shortcuts Settings, but cannot display it (just empty)

[enhancement] Persistent Panel on Multi-monitor Setup

When using multiple monitors, if the panel is on a "smaller" monitor and the app is on a "larger" monitor, "sometimes," the shortcuts don't align to the panel's top, and some shortcuts are not viewable.

Larger Monitor = 27" Studio Display
Smaller Monitor = 16" MacBook Pro

Chip Apple M1 Max
macOS Sonoma 14.2.1


Proper

Here, the active app is on the MacBook (Screenshot is of MacBook)
Screenshot 2024-01-27 at 12 37 02 PM

Alignment Issue

Here, the active app is on the Studio Display (Screenshot is of MacBook)
Screenshot 2024-01-27 at 12 38 52 PM

No Show Issue

Here, the active app is on the Studio Display (Screenshot is of MacBook)
Screenshot 2024-01-27 at 12 37 17 PM

KeyClu Settings

Screenshot 2024-01-27 at 12 46 44 PM

White lines and layout shift when scrollbar is necessary

If a scrollbar is necessary due to many items (e.g. in Xcode) the scrollbar appears with a delay causing some layout shift.
Also white lines are visible between some columns in this case (in Xcode with 4 columns it is before the third and fourth column)

Able to record shortcuts that include multiple letters

Proposal

I use Freshservice for work and many of the shortcuts don't use modifier keys, but instead use 2 letters i.e. g + d, g + b, etc. and I realized when trying to record these shortcuts in KeyClu that it is currently only possible to include any combination of modifier keys with up to 1 character. It would be great if I could record these aforementioned shortcuts as well, or if it isn't possible using the recording method of inputting a shortcut, even just being able to choose to enter the shortcut as plain text instead of recording it would be a very welcome and appreciated update. Thanks as always for your incredible development!

Alternatives

Have the option to, instead of recording a shortcut, type out a given shortcut in plain text, particularly for shortcuts that require more than 1 standard key (letter, number, symbol, etc.). e.g. it is currently impossible to record a shortcut such as g + d because it is only possible to include 1 standard key in a given shortcut using the recording method of inputting a shortcut.

[feature]: toggles on primary window

Proposal

Instead of making the user go into the settings to toggle which items to show, how about putting the toggles at the bottom of the window?

There's lots of room next to the Keyclu on the bottom-left for example.

I'm thinking of these toggles primarily:

  • Show bookmarks
  • Show user-hidden menu items
  • Show inactive menu items

Maybe even (but less important):

  • My shortcuts
  • macOS Keyboard Shortcuts

But I'm also thinking of another toggle, which I'll create a separate Feature Request #66 for:

  • Show menu items with no assigned shortcut (this is to make use of the very convenient CustomShortcuts functionality)

Thanks for considering.

Alternatives

Just have to go into the Settings to toggle things on and off.

[Feature Request] Panel Width Configuration?

@Anze,

I just download KeyClu and I'm loving the application thus far! Especially how simple it is to just double hit the cmd key to bring up the shortcuts.

I do have a suggestion for you to consider that well help the app's readability on large screens. Would it be possible to implement a configuration option to set the desired panel width based on % or px? For example, give users the opportunity to set the width of the panel to:

  • `25%
  • 50%
  • 75%
  • etc.
  • 1024px
  • and/or define a custom % or px width?

I have a 49" ultra-widescreen and it's hard to quickly scan/read through the shortcuts because the panel is so wide. I can't see everything in 1 glance. The title of the shortcut and the shortcuts themselves are so far apart it's hard to see the relationship.

Thanks for considering!

Crash if permission are not granted

After updating to 0.19 from 0.18, the setting page always crashes and cannot be open if the Accessibility and permissions are not granted. With said permission, if you try starting the setting page the app crashes and quits.

[feature request] Manually register shortcuts

Ability to register custom keybindings manually, such as keybindings that i want to remember (or need a reminder of).

My use case:
I have plenty of different apps where i use keyboard shortkeys, but since there are so many of them i sometimes forget those. For example, i have manually configured keybindings for terminal, for my vim code editor, for window management (using Magnet app) etc etc. So i would love to have a place where i can add my keybindings to the config and see them by invoking a help pop-up modal same way as apps like KeyCue does.

Startup App

Make it so that KeyCLU is launched automatically when the computer boots.

Persistent window not working?

Hi,

Maybe I'm doing something wrong but I can't get the persistent window to work. Pressed the command key three times. Nothing happens.

Looks to be enabled int the settings.

image image

[bug]: Shortcuts/Persistent Panel shows KeyClu shortcuts instead of active application after search in shortcuts panel

Description

Not sure if this was reported before, but if I trigger the shortcuts panel, trigger the search box via the shortcut key, then exit by pressing Esc, when I go to trigger the shortcuts panel again or the persistent panel, it shows me the KeyClu shortcuts instead of the current application's shortcuts.

I have to click inside the app's window to bring it into focus for the shortcuts panel to show the respective shortcuts again.

Expected behavior

Opening the shortcuts panel again after having tried a search in the previous shortcuts panel should show the same application's shortcuts still.

App version

0.23.1

macOS version

macOS Sonoma 14.4

Installation method

Homebrew

Checklist before submitting a bug

[feature request] Option to Redirect to CustomShortcuts App

CheatSheets has a pencil appear whenever you hover over a shortcut. When you click it, if you have CustomShortcuts installed (custom shortcut manager), it launches it and inputs the name of the shortcut you clicked then lets you rebind it. Could this be added as a feature even if disabled by default? Thanks.

[feature] KeyClu & skhd

Can I list my own shortcuts I have inside my skhdrc?

Basically I would like to press a keybind and have it show all my shortcuts I have listed in my skhd. Is this possible, even if I have to manually add them.

I guess what I'm asking for is the ability to add custom sheets and assign to a key binding in skhd
hyper - s : KeyClu --sheet SHEETNAME --toggle-persistent

This would be a great feature for programs like Yabai/skhd and other global shortcuts not related to s specific program!

Of course if something similar doesn't already exist.

Thanks!

Originally posted by @gldtn in #46

[bug]: auto switch current window to desktop

Description

When trigger panel in Jetbrain software, after release, keyclu will auto switch current window to desktop

Expected behavior

never auto switch

App version

0.23.1

macOS version

macOS Sonoma 14.4

Installation method

Homebrew

Checklist before submitting a bug

[feature] Create a "report" for app shortcuts

Hi,
It would be great if KeyClu could create a plain text file listing all the shortcut of an app (even better a table in one of the many markdown dialects). Essentially the same content of the panel but saved in a file.
The creation of the document could be triggered using a button at the bottom of the panel.
I think it wold be useful when reorganizing shortcuts of an app that has a lot of them and you have to check which combinations are already taken, the associated menu items, etc.

No German Umlauts

In German Location Apps like Safari or Photoshop uses lots of Ü, Ä, Ö or Characters like ` and / and so on (⌘+Ü for Example). These Shortcuts are shown only as "⌘" – missing second key. It would be fine if KeyClu can be fixed for Languages with Umlauts or other special characters on the Keyboard.

Persistant Panel Doesn't Activate

With the new update, the Persistent Panel isn't working. I tried the trick of selecting "none" and then selecting the option to show it, but it isn't working this time.

Scroll Lag

Hi, I'm on macOS Ventura and scrolling through the list is choppy. Is it intentionally like that for better performance?

Hide obvious menu items (noise)

My eyes get distracted when there is a lot of text on my screen 😵‍💫

I'd like to maintain a personal list of shortcuts that are extremely obvious to me (such as ⌘C Copy, ⌘Z Undo, etc...) and have KeyClu filter them out from the overview.

Any small reduction in the amount of clutter helps me out!

Thank you for your consideration 😊

List of shortcuts for Skype is much shorter than it actually has

I've compared what I see in the KeyClue for Skype.app with the official list provided by SKype here and it appears many of those aren't displayed.
Is that due to any limitations of the KeyClue, like inability to extract all shortcuts from Electron-based apps, which Skype is, or just a bug?

Add command line trigger for "show shortcuts"

I started using skhd as a hotkey manager, but unfortunately it seems to conflict with KeyClu, as the KeyClu shortcuts don't work anymore :(

I think the easiest way to provide support for this setup, as well as many other possible setups, would be to provide a command line trigger, for example:

/Applications/KeyClu.app/Contents/MacOS/KeyClu --showShortcuts

Then it would be easy to use with skhd, or any other trigger that a user can imagine.

It would be nice of course for the cool Command-based shortcuts to work with skhd, but that could possibly, be too much work, be too hard to solve, or even impossible under macOS. So investigating the specific interaction with skhd sounds like a riskier use of time.

RFE: no icon mode

With recent notched macbooks it is valuable feature to disable menubar icon in settings to free up screen space.

Persistent Panel Activation

New user here.

The persistent panel trigger isn't working.

Chip Apple M1 Max
Memory• 64 GB
Startup disk
Macintosh HD
macOS Sonoma 14.2.1

Add delay

Nice app, thanks for making it!

I find myself accidentally triggering KeyClu quite often, it just flashes up on screen when I don't intend to trigger it. Would you consider adding the option to set a delay before it appears so we can fine tune how soon it appears after triggering?

Disable triple cmd (sticky window)

It would be great if you could disable the triple cmd sticky window in preferences.

I find it triggers too easily when I'm thinking / hesitating and have my thumb on the cmd key and as there's no native way to remap the trigger I'd like to disable it if possible?

image

[Feature request] Show alert when something could have been done with a shortcut

Hi! This is a great app, thanks for the amazing job!

Was wandering if KeyClu could make an option to monitor when the user do something that could be done with a shortcut "manually", and then display some alert or display.

Personally, I would like the program to have a very aggressive behavior, like freezing my screen for a second or two, to "punish" me for not knowing the correct shortcut. It would be an opportunity to force the user to learn, which is good (I, for example, was used to Windows shortcuts, and miss knowing them in MacOS).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.