3 Rust Analyzer is an **experimental** modular compiler frontend for the Rust
4 language. It is a part of a larger rls-2.0 effort to create excellent IDE
5 support for Rust. If you want to get involved, check the rls-2.0 working group
6 in the compiler-team repository:
8 https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0
10 Work on the Rust Analyzer is sponsored by
12 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
13 - [Mozilla](https://www.mozilla.org/en-US/)
15 ## Language Server Quick Start
17 Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
18 you might encounter critical bugs. That said, it is complete enough to provide a
19 useful IDE experience and some people use it as a daily driver.
21 To build rust-analyzer, you need:
23 * latest stable rust for language server itself
24 * latest stable npm and VS Code for VS Code extension
26 To quickly install rust-analyzer with VS Code extension with standard setup
27 (`code` and `cargo` in `$PATH`, etc), use this:
31 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
33 # install both the language server and VS Code extension
36 # alternatively, install only the server. Binary name is `ra_lsp_server`.
37 $ cargo xtask install --server
40 For non-standard setup of VS Code and other editors, or if the language server
41 cannot start, see [./docs/user](./docs/user).
45 If you want to **contribute** to rust-analyzer or just curious about how things work
46 under the hood, check the [./docs/dev](./docs/dev) folder.
48 If you want to **use** rust-analyzer's language server with your editor of
49 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
50 you be more productive when using rust-analyzer.
54 We are on the rust-lang Zulip!
56 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
60 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
61 * Website: https://rust-analyzer.github.io/
65 Rust analyzer is primarily distributed under the terms of both the MIT
66 license and the Apache License (Version 2.0).
68 See LICENSE-APACHE and LICENSE-MIT for details.