Usage

After installation you can use the DivBrowse CLI to start a local instance of DivBrowse on your computer. You only have to provide a .vcf/.vcf.gz file and a .gff/.gff3 file in a subdirectory. Within the subdirectory you can start a DivBrowse instance via the following command:

$ divbrowse start --infer-config

An attempt is made to infer the configuration from the data provided.

If you want to improve and customize the configuration, you can take the example config YAML file divbrowse.config.yml.example (click to open) file from the GitHub repository, rename it to divbrowse.config.yml and edit it to fit your requirements.

If you provide a divbrowse.config.yml you can start a DivBrowse instance using this customized configuration by executing the following CLI command in the directory consisting the config YAML file:

$ divbrowse start

DivBrowse CLI reference

divbrowse

This is the DivBrowse CLI

divbrowse [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

start

divbrowse start [OPTIONS]

Options

--host <host>

IP address to bind the DivBrowse server to

Default

0.0.0.0

--port <port>

Port number to bind the DivBrowse server to

Default

8080

--infer-config

If set: infer a basic configuration from the provided VCF and GFF/GFF3 files and do not use an existing divbrowse.config.yml

--save-config <save_config>

Save the inferred configuration as a YAML file. Please provide a relative or absolute path.