https://github.com/cursorless-dev/cursorless

Don't let the cursor slow you down
https://github.com/cursorless-dev/cursorless

structure-editor talonvoice voice voice-coding vscode vscode-extension

Last synced: 23 days ago
JSON representation

Don't let the cursor slow you down

• Host: GitHub
• URL: https://github.com/cursorless-dev/cursorless
• Owner: cursorless-dev
• License: mit
• Created: 2021-02-18T15:59:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T20:10:11.000Z (6 months ago)
• Last Synced: 2024-05-22T20:24:09.532Z (6 months ago)
• Topics: structure-editor, talonvoice, voice, voice-coding, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://www.cursorless.org/
• Size: 15.4 MB
• Stars: 1,075
• Watchers: 10
• Forks: 77
• Open Issues: 596
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-github-repos - cursorless-dev/cursorless - Don't let the cursor slow you down (TypeScript)

README

        
Welcome to Cursorless!



  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



Cursorless is a spoken language for structural code editing, enabling developers to code by voice at speeds not possible with a keyboard. Cursorless decorates every token on the screen and defines a spoken language for rapid, high-level semantic manipulation of structured text.

Checkout the [docs](https://www.cursorless.org/docs/) and [videos](https://www.youtube.com/channel/UCML02pamUSxtbwAcrUdVmXg) to learn more. See [installation](https://www.cursorless.org/docs/user/installation/) for installation instructions.

And I heard you like GIFs?

![Curly repack ox](images/curlyRepackOx.gif)

![Move arg air and each to after drum](images/moveArgAirAndEachToAfterDrum.gif)

![Chuck tail red pipe slice past end of file](images/chuckTailRedPipeSlicePastEndOfFile.gif)

## Installation

Currently depends on [Talon](https://talonvoice.com/), though a keyboard

version is planned.

See [installation](https://www.cursorless.org/docs/user/installation/) for installation instructions.

## Extension Settings

This extension contributes the following settings:

- `cursorless.showOnStart`: Whether decorations should appear on workspace start

- `cursorless.hatSizeAdjustment`: Percentage to increase or decrease hat size; positive increases size

- `cursorless.hatVerticalOffset`: How much to vertically shift the hats as a percentage of font size; positive is up

- `cursorless.hatEnablement.colors`: Whether to enable particular hat colors.

- `cursorless.hatEnablement.shapes`: Whether to enable particular hat shapes.

- `cursorless.hatPenalties.colors`: How much to penalize each hat color. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.

- `cursorless.hatPenalties.shapes`: How much to penalize each hat shape. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.

- `cursorless.maximumHatStylePenalty`: The maximum allowed penalty for a hat style. Any hat style whose penalty is greater than this amount will not be used. A hat style penalty is defined to be the shape penalty plus the colour penalty. Setting this value less than or equal to zero is treated as no maximum.

## Known Issues

- Cursorless calculates the position of the hats based on the characteristics of your font. If you find that the hats are off center you can try running this command: `cursorless.recomputeDecorationStyles`

## Contributing

See [contributing](https://www.cursorless.org/docs/contributing/).

## Change Log

See [CHANGELOG.md](CHANGELOG.md).

## Attributions

See [NOTICE.md](NOTICE.md).