Skip to content

imandra-ai/imandrax-vscode

Repository files navigation

ImandraX VSCode extension

This is the VSCode extension for the ImandraX automated reasoning engine and interactive theorem prover.


ImandraX

Installing ImandraX

To use the ImandraX extension, an imandrax-cli binary must be in your PATH. If that's missing, this extension will prompt you to install it. It will effectively run the script from http://imandra.ai/get-imandrax.sh with all of the default options.

Supported platforms

ImandraX is currently supported on MacOS, Linux, and Windows via WSL. To use this extension on Windows, set up WSL and initiate VSCode remote development in WSL.

Opening .iml files

Once installed, the ImandraX extension will be enabled whenever you open or create an .iml file.

If the ImandraX VSCode extension is installed and imandrax-cli is not, then you'll see something like this the first time you open an .iml file:

Launch installer prompt

If you launch the installer, then you'll see a progress notification for the duration of the install:

Progress notification

Viewing installer logs

The installer is generally silent, but if you want to see the output, it's available in VSCode's output panel and log files:

Log view

API key configuration

If everything goes well, then you should prompted to enter your API key (or, if one was previously configured, to use an existing API key):

API Key prompt

Note: API keys are available from https://universe.imandra.ai/user/api-keys.

Wrapping up

Once the installation is complete, you'll be prompted to reload the window:

Installation complete

After that, you should be able to use ImandraX.

Debug settings

If anything goes wrong, you'll want to enable additional output, e.g. by adding some or all of the following settings to your existing ones in your workplace configuration (usually in .vscode/settings.json):

 "imandrax.lsp.arguments": [
    "lsp",
    ...
    "--debug-lsp",
    "--log-level=debug",
    "--debug-file=/tmp/lsp.log"
  ],
  "imandrax.lsp.environment": {
    ...
    "OCAMLRUNPARAM": "b"
  }

About

VS Code extension for ImandraX

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6