In this guide, we'll get an instance of JBrowse web running on your computer's browser.
Just want to download JBrowse web and get started? Follow our JBrowse web quick start.
Want JBrowse desktop? Follow our JBrowse desktop quick start.
- Ability to run commands on the command line
- A stable and recent version of node
Downloading JBrowse 2 using the JBrowse CLI
The JBrowse CLI can help perform many tasks to help you manage JBrowse 2, such as:
- create a new instance of JBrowse 2 automatically
- update an existing instance of JBrowse 2 with the latest released version
- configure your JBrowse 2 instance
Installing the CLI tools
To globally install the JBrowse CLI, run
npm install -g @jbrowse/cli
After running this command you can then test the installation with
which will output the current version of the JBrowse CLI.
If you can't or don't want to globally install the JBrowse CLI, you can also use
the npx command, which
is included with Node.js, to run JBrowse CLI without installing it. Simply
npx @jbrowse/cli in any command, e.g.
npx @jbrowse/cli --version
jbrowse create to download JBrowse 2
In the directory where you would like to download JBrowse 2, run
jbrowse create jbrowse2
Checking the download
The directory where you downloaded JBrowse should look something like this:
Running JBrowse 2
JBrowse 2 requires a web server to run. It won't work if you try to directly
index.html in your web browser. We can use a simple server to check
that JBrowse 2 has been downloaded properly. Run
npx serve . # use npx serve -S . if you want to refer to symlinked data later on
which will start a web server in our JBrowse 2 directory.
Navigate to the location specified in the CLI's output (likely
Your page should look something like this:
Click on the sample config to see JBrowse 2 running with a demo configuration. It should look like this:
Congratulations! You're running JBrowse 2.
Now that JBrowse 2 is set up, you can configure it with your own genomes and tracks. There are two ways you can configure JBrowse 2: with the JBrowse CLI (tutorial here) or with JBrowse 2's built-in graphical configuration editing (guide here).