Skip to content

Commit

Permalink
Fix CLI README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
elliothershberg committed Jul 8, 2021
1 parent 2603d43 commit c736f73
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions products/jbrowse-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,16 @@ It is likely preferable in most cases to install the tools first however
## Commands

<!-- commands -->
* [`jbrowse add-assembly SEQUENCE`](#jbrowse-add-assembly-sequence)
* [`jbrowse add-connection CONNECTIONURLORPATH`](#jbrowse-add-connection-connectionurlorpath)
* [`jbrowse add-track TRACK`](#jbrowse-add-track-track)
* [`jbrowse add-track-json TRACK`](#jbrowse-add-track-json-track)
* [`jbrowse admin-server`](#jbrowse-admin-server)
* [`jbrowse create LOCALPATH`](#jbrowse-create-localpath)
* [`jbrowse help [COMMAND]`](#jbrowse-help-command)
* [`jbrowse set-default-session`](#jbrowse-set-default-session)
* [`jbrowse upgrade [LOCALPATH]`](#jbrowse-upgrade-localpath)

- [`jbrowse add-assembly SEQUENCE`](#jbrowse-add-assembly-sequence)
- [`jbrowse add-connection CONNECTIONURLORPATH`](#jbrowse-add-connection-connectionurlorpath)
- [`jbrowse add-track TRACK`](#jbrowse-add-track-track)
- [`jbrowse add-track-json TRACK`](#jbrowse-add-track-json-track)
- [`jbrowse admin-server`](#jbrowse-admin-server)
- [`jbrowse create LOCALPATH`](#jbrowse-create-localpath)
- [`jbrowse help [COMMAND]`](#jbrowse-help-command)
- [`jbrowse set-default-session`](#jbrowse-set-default-session)
- [`jbrowse upgrade [LOCALPATH]`](#jbrowse-upgrade-localpath)

## `jbrowse add-assembly SEQUENCE`

Expand Down Expand Up @@ -70,7 +71,7 @@ OPTIONS
show CLI help
-l, --load=copy|symlink|move|inPlace
Required flag when using a local file. Choose how to manage the data directory. Copy, symlink, or move the data
Required flag when using a local file. Choose how to manage the data directory. Copy, symlink, or move the data
directory to the JBrowse directory. Or use inPlace to modify the config without doing any file operations
-n, --name=name
Expand Down Expand Up @@ -179,11 +180,11 @@ EXAMPLES
$ jbrowse add-connection http://mysite.com/jbrowse/data/
$ jbrowse add-connection http://mysite.com/jbrowse/custom_data_folder/ --type JBrowse1Connection
$ jbrowse add-connection http://mysite.com/path/to/hub.txt --assemblyName hg19
$ jbrowse add-connection http://mysite.com/path/to/custom_hub_name.txt --type UCSCTrackHubConnection --assemblyName
$ jbrowse add-connection http://mysite.com/path/to/custom_hub_name.txt --type UCSCTrackHubConnection --assemblyName
hg19
$ jbrowse add-connection http://mysite.com/path/to/custom --type custom --config
$ jbrowse add-connection http://mysite.com/path/to/custom --type custom --config
'{"uri":{"url":"https://mysite.com/path/to/custom"}}' --assemblyName hg19
$ jbrowse add-connection https://mysite.com/path/to/hub.txt --connectionId newId --name newName --target
$ jbrowse add-connection https://mysite.com/path/to/hub.txt --connectionId newId --name newName --target
/path/to/jb2/installation/config.json
```

Expand Down Expand Up @@ -254,7 +255,7 @@ EXAMPLES
# no --load flag to add literal URL for this track to config.json
$ jbrowse add-track https://mywebsite.com/my.bam
# --load move to move the file
# --load move to move the file
$ jbrowse add-track /path/to/my.bam --name 'New Track' --load move
# --load inPlace puts /url/relative/path.bam in the config without performing any file operations
Expand Down Expand Up @@ -397,7 +398,7 @@ OPTIONS
EXAMPLES
$ jbrowse set-default-session --session /path/to/default/session.json
$ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1,
$ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1,
track2, track3
$ jbrowse set-default-session --view LinearGenomeView, --name newName --viewId view-no-tracks
$ jbrowse set-default-session --currentSession # Prints out current default session
Expand Down Expand Up @@ -438,6 +439,7 @@ EXAMPLES
```

_See code: [src/commands/upgrade.ts](https://github.com/GMOD/jbrowse-components/blob/v1.3.2/products/jbrowse-cli/src/commands/upgrade.ts)_

<!-- commandsstop -->

## Debugging
Expand Down

0 comments on commit c736f73

Please sign in to comment.