Keylogme One

This is the logger for keylogme.com. This logger records your keypresses and saves them in keylogme.com. See security.

View Demo · Report Bug · Request Feature

The end goal is to avoid or diminish the pain in your hands due to typing. Commonly known as RSI (Repetitive Strain Injury), tennis elbow, carpal tunnel syndrome, etc.

There are many great ergonomic keyboards , beautiful hardware out there. However, what is the layout of keys that best suits you? that does not overload some fingers? that makes you more productive?.

We all started with QWERTY, then heard of DVORAK, COLEMAK, Workman, Norman, Asset, Capewell-Dvorak, BEAKL, MTGAP, QGMLWB... ? Many layouts with a specific design criteria in mind but switching to one is not an easy task, you need a lot of practice and patience.

How can keylogme help?, here's how:

• Monitor : See the finger usage on your current layout based on your real usage
• Analyze : Compare your layout with others, find patterns to avoid or improve, remap shortcuts
• Adapt : fine tune or change your layout based on the stats

Of course, ergonomics is not just a nice keyboard and layout. It is also about posture, breaks, exercises.

So what is keylogme? well guessed, it is a keylogger!. You configure to track specific devices you want to track. And it runs 24/7 in your computer as a service, collecting your keystrokes.

There are 2 ways to use keylogme:

1. keylogme-zero: zero dependecies open source project that saves your stats locally.
2. keylogme-one: wrapper around keylogme-zero that saves your keystrokes in our server.

What the f***? This is not safe! people will know what I write! Our end goal is to have a heatmap of your keyboard usage, not to know what you write. See Security section for more information on how we mingle your content so it is undecipherable.

(back to top)

1. Get your api key for your computer in your keylogme account.

2. Clone the repo

   git clone https://github.com/keylogme/keylogme-one.git
   
   

3. Go to folder deploy and install with sudo permissions. Replace API_KEY with your api key.

   cd deploy && sudo -E ./install.sh API_KEY 

   With parameters

   If you want to install a specific version: ```sh cd deploy && sudo -E ./install.sh API_KEY v1.1.0 ```

4. Press some keypresses and go to your keylogme homepage.

(back to top)

1. Get your api key for your computer in your keylogme account.

2. Clone the repo

   git clone https://github.com/keylogme/keylogme-one.git
   

3. Go to folder deploy and install with sudo permissions. Replace API_KEY with your api key.

   cd deploy && sudo -E ./install.sh API_KEY 

   With parameters

   If you want to install a specific version: ```sh cd deploy && sudo -E ./install.sh API_KEY v1.1.0 ```

   Important! Give permissions to Input Monitoring

   Why? MacOS does not allow to read keypresses per each device. We have to grant a special permission called Input Monitoring located in Settings -> Privacy & security. We want to get stats per each device, f.e. your keyboard usage on your laptop's built-in keyboard or an external keyboard can have a different impact.

   The installation will guide you on how to give permissions of Privacy & security > Input monitoring to binary.

   

4. Press some keypresses and go to your keylogme homepage.

(back to top)

Go to your keylogme homepage and create your devices and shortcuts. Your service will be updated automatically after any change.

(back to top)

View Demo

(back to top)

• Sender to keylogme.com
• Reload on device & shortcut change

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Efrain Sotelo - @esoteloferry

Project Link: https://keylogme.com

(back to top)