Fork of helix with some PRs merged
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
dependabot[bot] 40647f03ed
build(deps): bump serde_json from 1.0.80 to 1.0.81 (#2447)
Bumps [serde_json](https://github.com/serde-rs/json) from 1.0.80 to 1.0.81.
- [Release notes](https://github.com/serde-rs/json/releases)
- [Commits](https://github.com/serde-rs/json/compare/v1.0.80...v1.0.81)

---
updated-dependencies:
- dependency-name: serde_json
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
3 years ago
.cargo docs: Auto generate command list 3 years ago
.github AppImage (#2089) 3 years ago
book feat(languages): add odin language (#2399) 3 years ago
contrib AppImage (#2089) 3 years ago
docs Fix typo (#2264) 3 years ago
helix-core feat(languages): git-ignore and git-attributes (#2397) 3 years ago
helix-dap Use which to resolve lsp/dap binaries 3 years ago
helix-loader helix-loader + helix-core now compile for WASM 3 years ago
helix-lsp build(deps): bump tokio from 1.17.0 to 1.18.1 (#2373) 3 years ago
helix-term Making the 'set-option' command help more descriptive. (#2365) 3 years ago
helix-tui fix typos (#2304) 3 years ago
helix-view cfg-gate unused functions on macos & windows (#2332) 3 years ago
runtime Monokai pro spectrum theme shows error in yellow on red background (#2433) 3 years ago
xtask Making the 'set-option' command help more descriptive. (#2365) 3 years ago
.envrc Work around a nix-direnv issue 3 years ago
.gitignore Dynamically load grammar libraries at runtime 3 years ago
CHANGELOG.md fix typos (#2304) 3 years ago
Cargo.lock build(deps): bump serde_json from 1.0.80 to 1.0.81 (#2447) 3 years ago
Cargo.toml migrate grammar fetching/building code into helix-loader crate 3 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md fix(docs): cleanup obsolete indents.toml mentions (#2327) 3 years ago
VERSION set VERSION file to dev (#1883) 3 years ago
base16_theme.toml Add markup support (#1525) 3 years ago
flake.lock Fix build on aarch64-darwin (#1789) 3 years ago
flake.nix Fix build on aarch64-darwin (#1789) 3 years ago
grammars.nix Use fromTOML on Nix >= 2.6.0 (#1892) 3 years ago
languages.toml languages: add inc files to php (#2440) 3 years ago
rust-toolchain.toml Switch rust-toolchain.toml over to stable 3 years ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 3 years ago
screenshot.png update screenshot (#1879) 3 years ago
shell.nix Fix nix shell by hardcoding the flakecompat library (#2196) 3 years ago
theme.toml theme ui.virtual capture for existing themes 3 years ago

README.md

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
hx --grammar fetch
hx --grammar build

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.

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 xcopy runtime %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).