A post-modern modal text editor.
Go to file
Poliorcetics 6618cf2d68
feat: shorten output for grammar fetching and building (#3396)
New look:

```
Fetching 102 grammars
98 up to date git grammars
4 updated grammars
        bash      now on 275effdfc0edce774acf7d481f9ea195c6c403cd
        beancount now on 4cbd1f09cd07c1f1fabf867c2cf354f9da53cc4c
        c         now on f05e279aedde06a25801c3f2b2cc8ac17fac52ae
        c-sharp   now on 53a65a908167d6556e1fcdb67f1ee62aac101dda
```

```
Building 102 grammars
100 grammars already built
2 grammars built now
        ["bash", "rust"]
```
2022-08-17 10:37:10 +09:00
.cargo add integration-test cargo alias 2022-06-18 23:57:47 -04:00
.github chore(ci): match *-macos by checking suffix 2022-08-02 12:04:09 +09:00
book Improved file-picker configuration documentation (#3422) 2022-08-14 13:36:08 -05:00
contrib fix: add elvish completions (#3331) 2022-08-05 09:50:47 +09:00
docs Fix hyperlink at the bottom of CONTRIBUTING.md (#3392) 2022-08-11 08:57:17 -05:00
helix-core Fix nondeterministic highlighting (#3275) 2022-08-05 09:12:14 +09:00
helix-dap DAP: Make cwd required in RunTerminalArguments 2022-07-05 12:34:03 +02:00
helix-loader feat: shorten output for grammar fetching and building (#3396) 2022-08-17 10:37:10 +09:00
helix-lsp Advertise WorkspaceSymbolClientCapabilities support (#3361) 2022-08-09 11:51:10 +09:00
helix-term remove duplicate entries from theme picker (#3439) 2022-08-16 00:18:04 +09:00
helix-tui build(deps): bump crossterm from 0.23.0 to 0.24.0 (#2968) 2022-07-05 19:30:33 +09:00
helix-view Add custom event type replacing crossterm's Event (#3169) 2022-08-09 10:31:26 +09:00
runtime Add emacs theme (#3410) 2022-08-16 19:57:28 -05:00
xtask Add workspace and document diagnostics picker (#2013) 2022-06-30 18:16:18 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitattributes Add .gitattributes (#3318) 2022-08-03 08:21:51 -05:00
.gitignore Remove vale from .gitignore 2022-07-26 10:22:28 +09:00
.ignore Add a .ignore file to make ripgrep more useful (#3315) 2022-08-03 09:00:39 -05:00
base16_theme.toml Update theme base16_default (ui.menu) (#2794) 2022-06-17 20:24:18 +09:00
Cargo.lock build(deps): bump futures-executor from 0.3.21 to 0.3.23 (#3446) 2022-08-15 18:29:32 -05:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md Fix link to pop-dark in CHANGELOG.md (#2594) 2022-05-28 13:11:31 -05:00
default.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
flake.lock nix: update nixCargoIntegration (#2907) 2022-06-29 17:53:56 +09:00
flake.nix Only add cargo-tarpaulin on x86_64 (#3252) 2022-07-31 14:52:54 -05:00
grammars.nix build(nix): add a way to override what grammars get built (#3141) 2022-07-27 12:52:07 -05:00
languages.toml Update Clojure language definition (#3387) 2022-08-10 16:57:23 -05:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md adds xcopy param to recursively copy runtime folder (#3378) 2022-08-09 20:47:04 -05:00
rust-toolchain.toml pin the rust toolchain to 1.61.0 2022-05-24 01:05:19 +09:00
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2021-07-23 18:11:22 +09:00
screenshot.png update screenshot (#1879) 2022-03-30 00:16:57 +09:00
shell.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
theme.toml Add a default cursorline style for the primary selection 2022-06-27 17:27:24 +09:00
VERSION Fix the VERSION file 2022-05-29 01:07:30 +09:00

Helix

Build status

Screenshot

A kakoune / neovim inspired editor, written in Rust.

The editing model is very heavily based on kakoune; during development I found myself agreeing with most of kakoune's design decisions.

For more information, see the website or documentation.

All shortcuts/keymaps can be found in the documentation on the website.

Troubleshooting

Features

  • Vim-like modal editing
  • Multiple selections
  • Built-in language server support
  • Smart, incremental syntax highlighting and code editing via tree-sitter

It's a terminal-based editor first, but I'd like to explore a custom renderer (similar to emacs) in wgpu or skulpin.

Note: Only certain languages have indentation definitions at the moment. Check runtime/queries/<lang>/ for indents.scm.

Installation

Packages are available for various distributions (see Installation docs).

If you would like to build from source:

git clone https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars. If you want to customize your languages.toml config, tree-sitter grammars may be manually fetched and built with hx --grammar fetch and hx --grammar build.

Helix also needs its runtime files so make sure to copy/symlink the runtime/ directory into the config directory (for example ~/.config/helix/runtime on Linux/macOS, or %AppData%/helix/runtime on Windows).

OS Command
Windows (cmd.exe) xcopy /e runtime %AppData%\helix\runtime
Windows (PowerShell) xcopy /e runtime $Env:AppData\helix\runtime
Linux/macOS ln -s $PWD/runtime ~/.config/helix/runtime

This location can be overridden via the HELIX_RUNTIME environment variable.

Packages already solve this for you by wrapping the hx binary with a wrapper that sets the variable to the install dir.

NOTE: running via cargo also doesn't require setting explicit HELIX_RUNTIME path, it will automatically detect the runtime directory in the project root.

In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.

Packaging status

MacOS

Helix can be installed on MacOS through homebrew via:

brew tap helix-editor/helix
brew install helix

Contributing

Contributing guidelines can be found here.

Getting help

Your question might already be answered on the FAQ.

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).