Argus: a Trait Debugger for Rust

Argus is a tool to help you with compiler errors related to traits. If you have ever seen an error that says the trait bound ... is not satisfied, that is a good opportunity to use Argus. An IDE extension is available for VSCode which provides the Argus Inspection Panel. Read the trait debugging tutorial to learn more.

Limitations

:warning: Argus is research software and is under active development! :warning:

Argus relies on the New Trait Solver for Rust. Therefore, Argus inherits all the limitations of that solver which is also under active development. The New Trait Solver is known to be incomplete — while using Argus you may accidentally run into areas of Rust where the solver is limited. This does not mean that Argus is useless. The New Trait Solver is only used to type-check the current workspace and is still useful to debug a wide-range of trait errors.

https://github.com/user-attachments/assets/9a544060-e8ad-455e-9831-5e5d48c96542

Installation

Argus is available as a VSCode extension. You can install Argus from the VSCode Marketplace or the Open VSX Registry. In VSCode:

• Go to the extensions panel by clicking this button in the left margin:

• Search for "Argus" and click "Install".

• Open a Rust workspace and wait for Argus to finish installing.

Building from source

Some additional software is needed to build Argus from source. For the TypeScript bindings, you need to install the language Guile. The IDE requires Depot. Afterward run

$ cargo make init-bindings

$ cargo install --path crates/argus-cli

$ cd ide && depot build

FAQ

rustup fails on installation

If rustup fails, especially with an error like "could not rename the downloaded file", this is probably because Argus is running rustup concurrently with another tool (like rust-analyzer). Until rustup#988 is resolved, there is, unfortunately, no automated way around this.

To solve the issue, go to the command line and run:

rustup toolchain install nightly-2024-05-20 -c rust-src -c rustc-dev -c llvm-tools-preview

Then go back to VSCode and click "Continue" to let Argus continue installing.

Where does the name come from?

Argus or Argos Panoptes (Ancient Greek: Ἄργος Πανόπτης, "All-seeing Argos") is a many-eyed giant in Greek mythology.

Argus was Hera's servant. His great service to the Olympian pantheon was to slay the chthonic serpent-legged monster Echidna as she slept in her cave. Hera's defining task for Argus was to guard the white heifer Io from Zeus, who was attracted to her, keeping her chained to the sacred olive tree at the Argive Heraion. She required someone who had at least a hundred eyes spread out, always watching in all directions, someone who would stay awake despite being asleep. Argos was meant to be the perfect guardian.

—Wikipedia

Having trouble? (or providing feedback!)

We're happy to chat and answer questions on the Argus Zulip channel. You can also reach the authors via email, gavinleroy@brown.edu and wcrichto@brown.edu, we'd love to hear your feedback as we iterate in the design and development of Argus!