Installing & Building MyST Locally

A description of getting started with development is given in the README; we will also outline the basic process here. MyST uses Bun as its package manager and JavaScript runtime; you will need to install Bun before running the commands in this section.

First, use bun in the base directory to install the MyST dependencies:

$ bun install

After installing the dependencies, we can then build the MyST application

$ bun run build

The build process may take a minute, as it has to build every package when run for the first time. Subsequent calls to bun run build will be faster as they cache unchanged intermediate dependencies. Finally, we need to make the myst binary that was built available to our terminal:

$ bun run link

After running these steps, the MyST CLI (as described in Scientific Articles) can be used.