rust-analyzer README

The project's README from github.com/rust-lang/rust-analyzer. As one markdown file: README.md.

rust-analyzer logo

rust-analyzer is a language server that provides IDE functionality for writing Rust programs. You can use it with any editor that supports the Language Server Protocol (VS Code, Vim, Emacs, Zed, etc).

rust-analyzer features include go-to-definition, find-all-references, refactorings and code completion. rust-analyzer also supports integrated formatting (with rustfmt) and integrated diagnostics (with rustc and clippy).

Internally, rust-analyzer is structured as a set of libraries for analyzing Rust code. See Architecture in the manual.

codecov

Quick Start

https://rust-analyzer.github.io/book/installation.html

Documentation

If you want to contribute to rust-analyzer check out the CONTRIBUTING.md or if you are just curious about how things work under the hood, see the Contributing section of the manual.

If you want to use rust-analyzer's language server with your editor of choice, check the manual. It also contains some tips & tricks to help you be more productive when using rust-analyzer.

Security and Privacy

See the security and privacy sections of the manual.

Communication

For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:

https://users.rust-lang.org/c/ide/14

For questions about development and implementation, join rust-analyzer working group on Zulip:

https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer

License

rust-analyzer is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

rust-analyzer (rust-lang/rust-analyzer)

Searching Database…

What is this?rust-analyzer is a language server that provides IDE functionality for writing Rust programs — the code-intelligence engine you use while writing Rust in an editor.
Is this an app I run on its own, or something that lives inside my editor?Neither a standalone app nor an editor itself: it's a language server that your editor connects to. Internally it's even built as a set of libraries for analyzing Rust code.
How do I get it running in my editor?The README points you to the manual: it has installation instructions for your editor of choice, plus tips and tricks for being more productive with rust-analyzer.
Which editors can I use it with?Any editor that speaks the Language Server Protocol — the README names VS Code, Vim, Emacs and Zed, among others.
Is rust-analyzer an official Rust project or a third-party tool?It's developed under the official rust-lang organization on GitHub, has been around since December 2017 and counts roughly 16.9k stars, with CI and fuzzing workflows in the repo.
Why is it called a compiler front-end — does it replace rustc?No. Front-end here means it parses and analyzes Rust code the way a compiler would, but the output is IDE intelligence for your editor, not compiled binaries; rustc and clippy still supply diagnostics.
Creator
rust-lang
Size
123.7 MB
Stars
16.9K
Age
8y
Commits · 90 Days