Jscoq

Run the Coq Proof Assistant in your browser!

jsCoq is an Online Integrated Development Environment for the Coq proof assistant and runs in your browser! We aim to enable new UI/interaction possibilities and to improve the accessibility of the Coq platform itself.

The current stable version is jsCoq 0.17.1 supporting Coq 8.17.1, try it:

https://coq.vercel.app

The easiest way to use jsCoq 0.17.1 for your classes is to use our coqdoc template.

Don't hesitate to get in touch with us at the jsCoq's Zulip Room for any question or help request you may have.

jsCoq is written to conform to ES2017; any recent standard-compliant browser should be able to run it. No servers or external programs are needed. See the Troubleshooting section if you have problems.

jsCoq is community-developed by a team of contributors. We are in need of help, in particular with documentation, funding, and fine tuning the project, see the contributing section for more information.

Development version

The current development version is jsCoq 1.99.1, targeting Coq 8.17 to Coq 8.21. The current development version is based on the new Flèche document manager and has significant changes. If you are interested in helping with this effort, please get in touch with us.

Contributing and Developer Information

See our contributing guide for more information.

The jsCoq is in need of funding, as of today, it is fully run by unpaid volunteers. If you think you could help with funding, don't hesitate to get in touch with us.

Are you a jsCoq user? Let us know!

Have you developed or taught a course using jsCoq? Do you have some feedback for us?

If so, please submit a pull request or an issue so we can add your lectures to the list of jsCoq users. This is essential to guarantee future funding of the project.

Basic Usage

The main page showcases jsCoq with a variety of proofs, available from the Examples drop-down menu.

Once jsCoq finishes loading, you can step through the proof using the arrow buttons on the toolbar (top right), or using these keyboard shortcuts:

| Shortcut | Action | |--------------------|------------------| | Alt-N or Alt-↓ | Go to next | | Alt-P or Alt-↑ | Go to previous | | Alt-Enter or Alt-→ | Go to cursor |

You can open a blank editor and experiment with your own Coq developments using the scratchpad. The same keyboard shortcuts apply here.

The scratchpad's contents are saved in your browser's local storage (IndexedDB, specifically), so they are not lost if you close the browser window or refresh the page. You can, in fact, store more than one document using the local open/save file dialogs:

| Shortcut | Action | |--------------------|------------------------------------------------------------------------------| | Ctrl-S | Save file (with the last name provided, or untitled.v) | | Ctrl-Shift-S | Save file as (prompts for file name; also has options to download or share the content) | | Ctrl-Alt-S | Save file to disk (using the browser's Save dialog, or preset destination) | | Ctrl-O | Open file (prompts for file name, supports tab completion) | | Ctrl-Alt-O | Open file from disk (using the browser's Open dialog) |

On Mac, replace Ctrl with ⌘ (command) and Alt with ⌥ (option), as is traditional.

Drag .v files from your local drive onto the scratchpad to open them. You can also drag multiple files, which will open up a project pane to the left of the editor, allowing you to switch between them; this functionality is still experimental.

Sharing your development

A small pastebin-like server based on Hastebin is available for sharing .v files between users. Open the save dialog (Ctrl-Shift-S) and click "Share"; then share the URL from your browser's location bar with anyone you like. The URL represents the state of the document at the moment it was shared, and this state is read-only. Every time you click "Share", a fresh URL is generated. Shared content is not saved forever, though; documents are typically available for a period of ~30 days.

How to build your own jsCoq documents

See the dedicated page for information on advanced options and jsCoq HTML embedding API. A quick setup can be done with:

$ npm install jscoq

then copy and adapt the template page page to your needs.

For a more detailed tutorial and information, refer to docs/embedding.md.

Publications

See the dedicated file

Examples

The main page includes a proof of the infinitude of primes by G. Gonthier. We provide some more examples as a showcase of the tool:

• The Software Foundations suite (so far, LF and PLF volumes):

  • https://jscoq.github.io/ext/sf

• Mike Nahas's Coq Tutorial: https://corwin-of-amber.github.io/jscoq/tut/nahas/nahas_tutorial.html

Outdated examples [but still working]

• dft.v: https://x80.org/rhino-coq/v8.11/examples/dft.html

  A small development of the theory of the Fourier Transform following Julius Orion Smith III's "The Mathematics of the Discrete Fourier Transform"

• equations: https://x80.org/rhino-coq/v8.11/examples/equations_intro.htmla

  Introduction to the Coq Equations package from the official documentation.

• The IRIS program logic, by Robbert Krebbers et al.

  https://x80.org/rhino-coq/v8.9/examples/iris.html

• Mtac: The Mtac tutorial by Beta Zilliani:

  https://x80.org/rhino-coq/v8.5/examples/mtac_tutorial.html

• StackMachine: The First chapter of the book "Certified Programming with Dependent Types" by Adam Chlipala:

  https://x80.org/rhino-coq/v8.5/examples/Cpdt.StackMachine.html

• MirrorCore:

  • A simple demo: https://x80.org/rhino-coq/v8.5/examples/mirrorcore.html

  • A demo of developing a cancellation algorithm for commutative monoids: https://x80.org/rhino-coq/v8.5/examples/mirror-core-rtac-demo.html

jsCoq Users:

Incomplete list of places where jsCoq has been used, more or less in reverse chronological order:

• Coq Platform Docs https://coq.inria.fr/platform-docs/
• EPIT 2020 - Spring School on Homotopy Type Theory
• Lectures on Separation Logic by Jean-Marie Madiot in MPRI's course "Proofs of programs", using Arthur Charguéraud's material. See it in action!
• CASS 2020, Coq Andes Summer School https://cass.pleiad.cl/
• Coq Winter School 2018-2019 (SSReflect & MathComp) https://team.inria.fr/marelle/en/coq-winter-school-2018-2019-ssreflect-mathcomp/
• Types Summer School: http://www-sop.inria.fr/teams/marelle/types18/
• Lectures at the "Journées Nationales du Calcul Formel" by Assia Mahboubi: https://specfun.inria.fr/amahboub/Jncf18/cours2.html
• Coq Winter School 2017-2018 (SSReflect & MathComp) Sophia Antipolis https://team.inria.fr/marelle/en/coq-winter-school-2017-2018-ssreflect-mathcomp/
• Elpi Tutorial / Demo at CoqPL 2017 Los Angeles https://lpcic.github.io/coq-elpi-www/tutorial-demo_CoqPL2018.html
• Mini Corso di Coq a Pavoda: http://www-sop.inria.fr/members/Enrico.Tassi/padova2017/
• School on "Preuves et Programmes" at l'École de Mines https://www-sop.inria.fr/marelle/mines/
• Several examples of the "Mathematical Components Book" https://math-comp.github.io/mcb/
• Mathematical Components, an Introduction, Satellite workshop of the ITP 2016 conference, August 27th, Nancy, France https://github.com/math-comp/wiki/wiki/tutorial-itp2016
• Coq Winter School 2016-2017 (SSReflect & MathComp) “Advanced Software Verification And Computer Proof”. Sophia Antipolis https://team.inria.fr/marelle/en/advanced-coq-winter-school-2016-2017/
• Coq Winter School 2016: “Advanced Software Verification And Computer Proof”. Sophia Antipolis https://team.inria.fr/marelle/en/advanced-coq-winter-school-2016/

jsCoq in the press

• http://www.mines-paristech.fr/Actualites/jsCoq-ou-Coq-dans-un-navigateur/2118
• https://news.ycombinator.com/item?id=9836900

Addon Packages

One of jsCoq's strengths is its support for bundling addon packages. In order to add your Coq package to jsCoq, you need to compile it with jsCoq's version of Coq. Head over to jscoq/addons for pointers to some well-known packages that have been compiled for jsCoq and are bundled with every version of jsCoq. You can use these as examples for bundling your own libraries.

Troubleshooting

Are you getting a StackOverflow exception? Unfortunately these are hard to fix; you may be stuck with them for a while.

• Clearing the browser cache usually solves lots of issues.
• Change browser, if using Firefox try Chrome, if using Chrome try Firefox.

Reporting Bugs

Feel free to use the issue tracker. Please include your browser/OS/user-agent and any command-line options.

Contact and on-line help

• jsCoq's Zulip Room, main developer chat
• jsCoq's gitter, legacy developer chat
• Coq's discourse [use the jscoq tag], for general announcements and questions