Skip to content

Instantly share code, notes, and snippets.

View Elliria's full-sized avatar

Elliria Elliria

  • New York
View GitHub Profile

AutoKey documentation exploration

  1. Clean the trash:
    rm -rf ~/.local/share/Trash/*
  2. Update the system:
    sudo apt update
  3. Install the dependencies:

VirtualBox Use

About

This document provides an example of creating a virtual machine in VirtualBox, cloning it, using the clone for tests, and deleting the clone. Note that cloning it is entirely optional, but can be handy for testing out software without constantly having to create virtual machines from scratch. Power-users can also use snapshots to achieve the same goal, but since those are a bit tricker to use than clones, I'm not including steps for those here.

Before you begin

When naming a new virtual machine, the name matters to the extent that VirtualBox pays attention to it, watches it for known keywords, and adjusts the VM's settings if a known keyword is detected. If, for example, you give a new VM the Ubuntu name, VirtualBox will automatically change the default Windows entries to Ubuntu entries. Alternatively, if you give a new VM the Foo name, the default Windows entries will be used and you'd need to adjust those entries manually if you wanted to use other settings

@Elliria
Elliria / AutoKeyVMBookmarks.html
Last active April 27, 2026 23:53
AutoKey VM Bookmarks
<DL><p>
<DT><H3 ADD_DATE="1769030183" LAST_MODIFIED="1771956887">Search</H3>
<DL><p>
<DT><A HREF="https://docs.github.com/en/search-github" ADD_DATE="1769030183" LAST_MODIFIED="1769030183" ICON_URI="https://docs.github.com/favicon.ico" ICON="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAADH0lEQVQ4T22Ta0iTURjH/2dze9XpnPfUTNcyTUtTKbtZlh+UKLGQLpQZqJnRjQIToy9ZEERYRqV9qCxFUYquIEUiWHQvNVHT6UxbWuq8rOmm7/Z2zhvKIB84cM55+P/OOc/zPwR2IQiChC7Xaj+PpPfqTAmjg5ZAgbdKVB5cv79G8Xbhcq9yjsMLQohlRkZmJlTsrmsbP/nuqT6r5b3Bd2TQDH7KJqalDgRKDw4hMaqxNUl+1UvivAoppI/lRAATt70ZvvL4Tne6tmmEbgAS6SxbhNhsAgTKC9C4IDkj+OXqZP8sCukh7Nr05LM1l7+d7qRi7wBn8NM2jA1ZRAihHCsvQKGUwUUlw6/eCfjMd0bakZCKqHifHAaIrypqr6mr7vNlgoyCcCwIU6KreRSu7nJI6d64YQp+aoUIupHfCOPoNKLX+0zuy1+WS7TNhpt3CluzB3pNcJBJcKAwEtEJPva1nZ33dRpRdOQT/oxOQeEmx+4ToQ2k/v6Pjpri9hCL2Yp5QQocK4qBl7/TnADzhBWlBU1oeTMkPi9xV7CZPCjRTtaWdTtarQJiN/oi53zkfwW0pz0s1eLZrW6xNpHrvEFqir9ZXlR+l9soIDzOE4cvRkPGMTvMHZWX2lFX3Sv2b+kqL5DaCl3PoxJtEKu8s6sM2bQGERQ0V/TrTLh+qpF2wkQBBBtSAnjS9HqwquJC607T

AutoKey manage the wiki locally

ToDo -- update me!

Clone the AutoKey wiki:

  1. Open the directory you'd like to put the clone's directory into in a terminal window.
  2. Clone the wiki, which will create the autokey.wiki directory inside of the current directory:
    git clone https://github.com/autokey/autokey.wiki.git
@Elliria
Elliria / autokey_run_tests_and_provide_feedback_on_a_pull_request.md
Last active March 24, 2026 18:55
AutoKey run tests and provide feedback on a pull request

AutoKey run tests and provide feedback on a pull request

Note

This needs to be reviewed. It's most likely deprecated.

πŸ›‘ Caution: Although the steps below have you creating and using a clone of AutoKey, the clone shares the same configuration folder as the installed copy of AutoKey. Since there's always a risk of corruption of files when one is testing new code, it's best not to run these tests on a system where the installed copy of AutoKey contains valued custom phrases and/or scripts. I recommend creating a virtual machine instead.

  1. Make sure that the system you'll be doing the tests on already has a working copy of AutoKey installed on it (so that you'll already have all the necessary apt dependencies).
  2. Install the git package in Kubuntu.
  3. Install the tox package in Kubuntu.
  4. Open the directory you'd like to create the cloned autokey directory inside of in a terminal window.
@Elliria
Elliria / AutoKeyVMNotes.md
Last active January 17, 2026 20:38
AutoKey VM Notes

AutoKey VM Notes

Contents of the Note widget

===============================================================
FIND ALL DUPLICATE FILES IN THE CURRENT DIRECTORY RECURSIVELY:
	fdupes -r .
===============================================================
FIND ALL FILES CONTAINING FOO IN THEIR NAME IN THE CURRENT DIRECTORY RECURSIVELY:
@Elliria
Elliria / autokey_run_clones_in_a_vm.md
Last active March 24, 2026 18:54
AutoKey run clones in a VM

AutoKey run clones in a VM

Note

This needs to be reviewed. It's most likely deprecated.

Prepare the machine for AutoKey development:

sudo apt install autokey-gtk
sudo apt install autokey-qt
sudo apt install git
sudo apt install libcairo2-dev

Update The Workflows

Update the action versions

  1. Open the `.github/workflows`_ directory on the develop branch.
  2. Check the action versions:
    1. Check the `build.yml`_ file:
@Elliria
Elliria / autokey_run_in_different_ways.md
Last active April 9, 2026 03:53
AutoKey run in different ways

AutoKey run in different ways

Note

This needs to be reviewed. It's most likely deprecated.

Before you begin

The testing methods below can be done inside of a terminal window on a machine that has AutoKey already installed on it (in fact, that's recommended since it will likely provide you with all of the necessary dependencies in advance).

πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘
It's important to note that lthough each instance of AutoKey will be independent, the AutoKey configuration from your installed copy of AutoKey will be used, which means all of these tests will have full access to your phrases and scripts and changes you make to those while testing will affect your installed version of AutoKey as well.
πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘ πŸ›‘