/cursorless-talon

The cursor never loved you anyway

Primary LanguagePythonMIT LicenseMIT

Cursorless talon

This repository contains the talon side of Cursorless.

Documentation

Full documentation can be found in docs, or by saying "cursorless docs". Once you understand the concepts, you can pull up a cheat cheat for reference using the command "cursorless help".

Installation

First, install the dependencies:

Dependencies

  1. Install Talon
  2. Install knausj_talon. Note that even a heavily modified version of knausj should be fine, but make sure you have merged since commit knausj85/knausj_talon@ff89cc1. If rebasing is too painful, or if you are not a user of knausj, you can just clone the command client into your talon user directory. You may need a couple other things from knausj but nothing major. Please file an issue if you have trouble getting this repo to work without knausj.
  3. Install VSCode
  4. Install the VSCode talon extension pack
  5. Install the Cursorless VSCode extension
  6. Follow the instructions below to install cursorless-vscode itself.

Installing this repo

Linux & Mac

Clone repo into ~/.talon/user

cd ~/.talon/user
git clone https://github.com/pokey/cursorless-talon cursorless-talon

Alternatively, access the directory by right clicking the Talon icon in taskbar, clicking Scripting>Open ~/talon, and navigating to user.

The folder structure should look something like the below:

~/.talon/user/knausj_talon
~/.talon/user/knausj_talon/apps
~/.talon/user/knausj_talon/code
...
~/.talon/user/cursorless-talon
~/.talon/user/cursorless-talon/src
...

Windows

Clone repo into %AppData%\Talon\user

cd %AppData%\Talon\user
git clone https://github.com/pokey/cursorless-talon cursorless-talon

Alternatively, access the directory by right clicking the Talon icon in taskbar, clicking Scripting>Open ~/talon, and navigating to user.

The folder structure should look something like the below:

%AppData%\Talon\user\knausj_talon
%AppData%\Talon\user\knausj_talon\apps
%AppData%\Talon\user\knausj_talon\code
...
%AppData%\Talon\user\cursorless-talon
%AppData%\Talon\user\cursorless-talon\src
...