https://github.com/verus-lang/verus

Verified Rust for low-level systems code
https://github.com/verus-lang/verus

Last synced: 9 days ago
JSON representation

Verified Rust for low-level systems code

• Host: GitHub
• URL: https://github.com/verus-lang/verus
• Owner: verus-lang
• License: mit
• Created: 2021-10-19T17:34:14.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:30:13.000Z (15 days ago)
• Last Synced: 2024-10-29T14:38:50.727Z (15 days ago)
• Language: Rust
• Size: 16.3 MB
• Stars: 1,186
• Watchers: 23
• Forks: 70
• Open Issues: 125
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Quick Start](https://img.shields.io/badge/tutorial-quick%20start-informational)](https://verus-lang.github.io/verus/guide/getting_started.html) [![Library Documentation](https://img.shields.io/badge/docs-vstd-informational)](https://verus-lang.github.io/verus/verusdoc/vstd/) [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://verus-lang.zulipchat.com)

#  

Verus is a tool for verifying the correctness of code written in Rust.

Developers write specifications of what their code should do,

and Verus statically checks that the executable Rust code will always 

satisfy the specifications for all possible executions of the code.

Rather than adding run-time checks, Verus instead relies on powerful solvers to

prove the code is correct.  Verus currently supports a subset of Rust (which we

are working to expand), and in some cases, it allows developers to go beyond

the standard Rust type system and statically check the correctness of code

that, for example, manipulates raw pointers.  

![VS Code Demo](source/docs/verus-demo.png)

## Status

Verus is under *active development*. Features may be broken and/or missing, and

the documentation is still incomplete. If you want to try Verus, please be

prepared to ask for help in the [💬 Zulip](https://verus-lang.zulipchat.com/).

The Verus community has published a number of research papers, and there are a variety of industry and academic projects using Verus. You can find a list on our publications and projects page. If you're using Verus please consider adding your project to that page (see the instructions there).

## Try Verus

To try Verus in your browser, please visit the [Verus Playground](https://play.verus-lang.org/).

For more involved development, please follow our [installation instructions](INSTALL.md).

Then you can dive into the documentation below, starting

with the [📖 Tutorial and reference](https://verus-lang.github.io/verus/guide/).

## Documentation

Our (work-in-progress) documentation resources include:

 * [📖 Tutorial and reference](https://verus-lang.github.io/verus/guide/)

 * [📖 API documentation for Verus's standard library](https://verus-lang.github.io/verus/verusdoc/vstd/)

 * [📖 Guide for verifying concurrent code](https://verus-lang.github.io/verus/state_machines/)

 * [Project Goals](source/docs/project-goals.md)

 * [Contributing to Verus](CONTRIBUTING.md)

 * [Verus License](LICENSE)

 * [Verus Logos](https://verus-lang.github.io/verus/verus/logo.html)

## Getting in touch, reporting issues, and starting discussions

Please report issues or start discussions here on GitHub, or join us on [💬 Zulip](https://verus-lang.zulipchat.com/) for more realtime discussions and if you need help. Thank you for using and contributing to Verus!

We use GitHub discussions for feature requests and more open-ended conversations about

upcoming features, and we reserve GitHub issues for actionable issues (bugs) with

existing features. Don't worry though: if we think an issue should be a discussion (or

vice versa) we can always move it later.

We welcome contributions! If you'd like to contribute code, have a look at the tips in

[Contributing to Verus](CONTRIBUTING.md).

---

[ Zulip](https://zulip.com/) sponsors free hosting for Verus. Zulip is an open-source modern team chat app designed to keep both live and asynchronous conversations organized.

Special thanks to Johanna Polzin for her contribution to the design of the Verus Logo. The Verus logos (bitmap and vector) are by the Verus Contributors and licensed under the terms of Creative Commons Attribution 4.0 International license.