@jbrowse/cli 4.2.1 → 5.0.0-beta.1

package/README.md

@@ -23,20 +23,20 @@ fs.writeFileSync('config.json', JSON.stringify(config, null, 2))
 
 The command line tools can be installed globally using `npm` as follows
 
-```sh-session
+```bash
 $ npm install -g @jbrowse/cli
 ```
 
 A CLI tool called `jbrowse` should then be available in the path. You can test
 your installation with
 
-```sh-session
+```bash
 $ jbrowse --version
 ```
 
 It is also possible to do one-off executions using npx, e.g.
 
-```sh-session
+```bash
 npx @jbrowse/cli create myfolder
 ```
 
@@ -54,12 +54,13 @@ COMMANDS
   create               Downloads and installs the latest JBrowse 2 release
   add-assembly         Add an assembly to a JBrowse 2 configuration
   add-track            Add a track to a JBrowse 2 configuration
+  validate             Check a configuration for errors, including ones JBrowse accepts silently
   text-index           Make a text-indexing file for any given track(s)
   admin-server         Start up a small admin server for JBrowse configuration
   upgrade              Upgrades JBrowse 2 to latest version
   make-pif             Creates pairwise indexed PAF (PIF), with bgzip and tabix
-  sort-gff             Helper utility to sort GFF files for tabix
-  sort-bed             Helper utility to sort BED files for tabix
+  sort-gff             Sort a GFF/GTF for tabix: sort -k1,1 -k4,4n, header kept on top
+  sort-bed             Sort a BED for tabix: sort -k1,1 -k2,2n, header kept on top
   add-connection       Add a connection to a JBrowse 2 configuration
   add-track-json       Add a track configuration directly from a JSON hunk
   remove-track         Remove a track configuration from a JBrowse 2 configuration
@@ -100,6 +101,8 @@ Options:
   -t, --tag                  Version of JBrowse 2 to install. Format is v1.0.0.
                              Defaults to latest
 
+Examples:
+
 # Download latest release from github, and put in specific path
 $ jbrowse create /path/to/new/installation
 
@@ -127,19 +130,19 @@ Usage: jbrowse add-assembly <sequence> [options]
 Options:
   -t, --type                 type of sequence, by default inferred from sequence
                              file
-                             
+
                              indexedFasta - An index FASTA (e.g. .fa or .fasta)
                              file; can optionally specify --faiLocation
-                             
+
                              bgzipFasta - A block-gzipped and indexed FASTA
                              (e.g. .fa.gz or .fasta.gz) file; can optionally
                              specify --faiLocation and/or --gziLocation
-                             
+
                              twoBit - A twoBit (e.g. .2bit) file
-                             
+
                              chromSizes - A chromosome sizes (e.g. .chrom.sizes)
                              file
-                             
+
                              custom - Either a JSON file location or inline JSON
                              that defines a custom sequence adapter; must
                              provide --name if using inline JSON [choices:
@@ -191,13 +194,21 @@ Options:
                              any file operations [choices: copy, symlink, move,
                              inPlace]
 
-      --skipCheck            Don't check whether or not the sequence file or URL
-                             exists or if you are in a JBrowse directory
+  -f, --force                Overwrite existing assembly and skip file existence
+                             checks
 
-      --overwrite            Overwrite existing assembly if one with the same
-                             name exists
+      --config               Any extra config settings to add to the assembly
 
-  -f, --force                Equivalent to `--skipCheck --overwrite`
+Notes:
+
+--config takes inline JSON (not a file path) that is merged into the generated
+assembly config, so you can set fields the dedicated flags do not cover. A
+"sequence" object in it is merged into the generated ReferenceSequenceTrack
+rather than replacing it, e.g. --config
+'{"sequence":{"formatAbout":{"hideUris":true}}}' hides file URIs in the
+assembly's About dialog.
+
+Examples:
 
 # add assembly to installation in current directory. assumes .fai file also exists, and copies GRCh38.fa and GRCh38.fa.fai to current directory
 $ jbrowse add-assembly GRCh38.fa --load copy
@@ -222,6 +233,9 @@ $ jbrowse add-assembly https://example.com/data/sample.2bit
 
 # add a bgzip indexed fasta inferred by fa.gz extension. assumes .fa.gz.gzi and .fa.gz.fai files also exists
 $ jbrowse add-assembly myfile.fa.gz --load copy
+
+# hide file URIs in the assembly About dialog
+$ jbrowse add-assembly GRCh38.fa --load copy --config '{"sequence":{"formatAbout":{"hideUris":true}}}'
 ```
 
 
@@ -233,10 +247,12 @@ Add a track to a JBrowse 2 configuration
 Usage: jbrowse add-track <track> [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
   -t, --trackType            Type of track, by default inferred from track file
 
+      --adapterType          Adapter type, by default inferred from track file
+
   -n, --name                 Name of the track. Will be defaulted to the trackId
                              if none specified
 
@@ -245,13 +261,32 @@ Options:
   -d, --description          Optional description of the track
 
   -a, --assemblyNames        Assembly name or names for track as comma separated
-                             string
+                             string. For pairwise synteny tracks the order is
+                             query,target (reverse of minimap2/nucmer argument
+                             order); for all-vs-all adapters
+                             (AllVsAllPAFAdapter/AllVsAllIndexedPAFAdapter) list
+                             every assembly the file covers, in any order
 
       --category             Optional comma separated string of categories to
                              group tracks
 
       --config               Any extra config settings to add to a track
 
+      --color                Track color: a plain CSS color or a jexl callback.
+                             Merged into displayDefaults
+
+      --height               Track display height in pixels. Merged into
+                             displayDefaults
+
+      --displayDefaults      Inline JSON merged into the track displayDefaults
+                             (labels, mouseover, jexlFilters, etc.)
+
+      --multiwig             Build a MultiQuantitativeTrack from several BigWigs
+                             (in place of the positional track arg): a
+                             comma-separated list of BigWig files/URLs, or a
+                             .json file holding an array of BigWig locations or
+                             subadapter objects, each with its own name/color
+
       --target               Path to config file in JB2 installation to write
                              out to
 
@@ -263,15 +298,11 @@ Options:
       --trackId              trackId for the track, by default inferred from
                              filename
 
-  -l, --load                 How to manage the track (copy, symlink, move,
-                             inPlace)
+  -l, --load                 How to manage the track file relative to
+                             config.json. Required for local files, omit for
+                             URLs [choices: copy, symlink, move, inPlace]
 
-      --skipCheck            Skip check for whether file or URL exists
-
-      --overwrite            Overwrites existing track if it shares the same
-                             trackId
-
-  -f, --force                Equivalent to --skipCheck --overwrite
+  -f, --force                Overwrite existing track and any existing files
 
       --protocol             Force protocol to a specific value
 
@@ -279,6 +310,41 @@ Options:
 
       --bed2                 Used only for mcscan anchors/simpleAnchors types
 
+Notes:
+
+--load controls how the data file is placed relative to config.json: copy, move,
+or symlink it into the install directory, or inPlace to reference a pre-staged
+local file where it already sits. Omit --load entirely for URLs. For a local
+file the matching index is whichever conventional spelling is actually beside it
+— <file>.bai/.crai/.tbi, a <file>.csi, or the reads.bai form Picard writes
+beside reads.bam. A URL cannot be checked, so it gets <file>.bai/.tbi; pass
+--indexFile for anything else.
+
+--config takes inline JSON (not a file path) that is merged into the generated
+track config, so you can set fields the dedicated flags do not cover, e.g.
+--config '{"metadata":{"skipTextIndex":true}}' to exclude the track from jbrowse
+text-index.
+
+--color and --height set the two most common appearance settings without writing
+JSON. Wrap the value in single quotes and use double quotes inside a jexl
+callback so nothing needs escaping, e.g. --color
+'jexl:feature.strand==1?"blue":"red"'. --displayDefaults takes inline JSON for
+any other appearance setting (labels, mouseover, jexlFilters).
+
+--multiwig bundles several BigWigs into one MultiQuantitativeTrack, in place of
+the positional track argument: pass a comma-separated list of BigWig files/URLs,
+or a .json file with an array of BigWig locations or subadapter objects (each
+carrying its own name/color/group). With --load, local list entries are copied
+like any other track file.
+
+For pairwise synteny adapters (PAF/Delta/Chain) --assemblyNames is query,target
+— the reverse of the minimap2/nucmer input order. For the all-vs-all adapters
+(AllVsAllPAFAdapter, AllVsAllIndexedPAFAdapter) it is instead the full list of
+assemblies the file covers, in any order, since one all-vs-all file backs every
+pair.
+
+Examples:
+
 # copy /path/to/my.bam and /path/to/my.bam.bai to current directory and adds track to config.json
 $ jbrowse add-track /path/to/my.bam --load copy
 
@@ -296,6 +362,65 @@ $ jbrowse add-track https://mywebsite.com/my.bam
 
 # --load inPlace adds a track without doing file operations
 $ jbrowse add-track /url/relative/path.bam --load inPlace
+
+# color a track by strand and set its height (no escaping: single-quote the value, double-quote inside the jexl)
+$ jbrowse add-track genes.gff3.gz --load copy --color 'jexl:feature.strand==1?"blue":"red"' --height 200
+
+# bundle several BigWigs into one MultiQuantitativeTrack (no positional track arg)
+$ jbrowse add-track --multiwig a.bw,b.bw,c.bw --load copy --name "Coverage"
+
+# ...or from a sources.json carrying per-row name/color for each BigWig
+$ jbrowse add-track --multiwig sources.json --name "CATlas ATAC"
+```
+
+
+## jbrowse validate
+
+```
+Check a JBrowse configuration for errors, including the ones JBrowse itself
+accepts silently
+
+Usage: jbrowse validate [config.json] [options]
+
+Options:
+      --json                 Output the findings as JSON instead of text
+
+  -q, --quiet                Only print errors, suppressing warnings and notes
+
+  -h, --help                 Show help
+
+Notes:
+
+A config key JBrowse does not recognize is ignored rather than reported, so a
+misspelled slot leaves the track loading normally with the setting doing
+nothing. That is what this command is mainly for.
+
+Two levels are reported:
+
+  error    JBrowse accepts it and silently does the wrong thing — an unknown    
+       slot, a track naming an assembly the config never defines, a           
+defaultSession naming a trackId that does not exist, a duplicate           
+trackId. Exits 1.
+
+  warning  JBrowse will complain by itself on load, or handles it — a type name 
+          the core plugins do not register (expected if one of your plugins     
+      registers it), or a legacy key a migration rewrites. Never fails          
+ the run.
+
+Types registered by plugins are not known to this command, so they come through
+as warnings rather than errors.
+
+Examples:
+
+# check the config.json in the current directory
+$ jbrowse validate
+
+# check a specific config or saved session
+$ jbrowse validate /path/to/config.json
+$ jbrowse validate mysession.jbrowse
+
+# machine-readable output
+$ jbrowse validate config.json --json
 ```
 
 
@@ -314,7 +439,9 @@ Options:
                              available tracks
 
       --excludeTracks        Specific tracks to exclude from indexing, formatted
-                             as comma separated trackIds
+                             as comma separated trackIds. To exclude a track
+                             permanently, set metadata.skipTextIndex on it in
+                             config.json instead (see Notes)
 
       --target               Path to config file in JB2 installation directory
                              to read from.
@@ -322,7 +449,7 @@ Options:
       --out                  Synonym for target
 
       --attributes           Comma separated list of attributes to index
-                             [default: Name,ID]
+                             [default: Name,ID,symbol]
 
   -a, --assemblies           Specify the assembl(ies) to create an index for. If
                              unspecified, creates an index for each assembly in
@@ -335,8 +462,13 @@ Options:
 
       --perTrack             If set, creates an index per track [default: false]
 
-      --exclude              Adds gene type to list of excluded types [default:
-                             CDS,exon]
+      --exclude              Comma separated list of feature types to exclude
+                             from indexing [default: CDS,exon]
+
+      --include              Comma separated list of feature types to index,
+                             dropping every other type. Unset by default, which
+                             indexes every type --exclude does not name. GFF3
+                             only
 
       --prefixSize           Specify the prefix size for the ixx index. We
                              attempt to automatically calculate this, but you
@@ -355,6 +487,33 @@ Options:
       --dryrun               Just print out tracks that will be indexed by the
                              process, without doing any indexing
 
+Notes:
+
+Individual tracks in config.json can be permanently excluded from indexing by
+setting "metadata": { "skipTextIndex": true } on the track. Such tracks are
+skipped even when indexing all tracks or a whole assembly, so you do not have to
+pass --excludeTracks on every run.
+
+Only tracks with an indexable adapter type (Gff3Adapter, Gff3TabixAdapter,
+GtfAdapter, GtfTabixAdapter, VcfAdapter, VcfTabixAdapter) are indexed; tracks
+with other adapter types are skipped automatically.
+
+GTF has no Name/ID attributes, so the default --attributes also match their GTF
+spellings (gene_name, transcript_name, gene_id, transcript_id).
+
+--exclude names types not to index; --include names the only types to index.
+Reach for --include when the file draws from a vocabulary you do not control: an
+NCBI RefSeq GFF3 uses 115 feature types, 80 of them leaf records with no name to
+search (a match is labelled with a bare UUID, a cDNA_match with an MD5, every
+biological_region with the string "biological region"), so a deny list leaks
+whichever type is added next while the allow list — gene, pseudogene and the
+transcript types — does not grow. Both may be given: --include admits, --exclude
+then narrows. Either can also be set per track in config.json as
+textSearching.indexingFeatureTypesToInclude / indexingFeatureTypesToExclude,
+which takes precedence over the flag.
+
+Examples:
+
 # indexes all tracks that it can find in the current directory's config.json
 $ jbrowse text-index
 
@@ -362,7 +521,7 @@ $ jbrowse text-index
 $ jbrowse text-index --tracks=track1,track2,track3
 
 # indexes all tracks except specific trackIds
-$ jbrowse text-index --exclude-tracks=track1,track2,track3
+$ jbrowse text-index --excludeTracks=track1,track2,track3
 
 # indexes all tracks in a directory's config.json or in a specific config file
 $ jbrowse text-index --out /path/to/jb2/
@@ -383,7 +542,7 @@ Start up a small admin server for JBrowse configuration
 Usage: jbrowse admin-server [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
   -p, --port                 Specified port to start the server on (default:
                              9090)
@@ -392,8 +551,26 @@ Options:
 
       --bodySizeLimit        Size limit of the update message (default: 25mb)
 
+Notes:
+
+The admin-server lets a browser session write changes back to config.json on
+disk, authorized by a one-time key printed in the startup URL. It is meant for
+local configuration only: run it on a trusted machine and do not expose the port
+to untrusted networks or the public internet.
+
+Examples:
+
+# start the admin server for the JBrowse install in the current directory
 $ jbrowse admin-server
+
+# start on a specific port
 $ jbrowse admin-server -p 8888
+
+# point at a specific JBrowse installation directory
+$ jbrowse admin-server --root /path/to/jb2/
+
+# raise the body size limit for very large config updates
+$ jbrowse admin-server --bodySizeLimit 100mb
 ```
 
 
@@ -423,6 +600,8 @@ Options:
 
   -u, --url                  A direct URL to a JBrowse 2 release
 
+Examples:
+
 # Upgrades current directory to latest jbrowse release
 $ jbrowse upgrade
 
@@ -451,28 +630,64 @@ creates pairwise indexed PAF (PIF), with bgzip and tabix
 Usage: jbrowse make-pif <file> [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
       --out                  Where to write the output file. will write
                              ${file}.pif.gz and ${file}.pif.gz.tbi
 
       --csi                  Create a CSI index for the PIF file instead of TBI
 
-$ jbrowse make-pif input.paf # creates input.pif.gz in same directory
+      --coarse               Minimum insertion/deletion length (bp) at which a
+                             coarse-tier row is split into multiple pieces so
+                             each row stays tight — 0 emits an unsplit coarse
+                             tier. Defaults to 10000. The no-CIGAR coarse tier
+                             (prefix T/Q) is emitted alongside the per-row CIGAR
+                             fine tier by default so whole-genome synteny views
+                             can auto-switch to it; pass --no-coarse to omit it.
+
+      --no-coarse            Do not emit the coarse no-CIGAR tier; write only
+                             the per-row CIGAR fine tier.
 
-$ jbrowse make-pif input.paf --out output.pif.gz # specify output file, creates output.pif.gz.tbi also
+Notes:
+
+Use --csi for assemblies containing sequences longer than ~512 Mb. The default
+TBI index cannot address coordinates beyond 2^29 (~536 Mb), so a CSI index is
+required for large chromosomes (e.g. some plant and amphibian genomes). Requires
+sh, sort, bgzip, and tabix on the PATH.
+
+Examples:
+
+# creates input.pif.gz and input.pif.gz.tbi in the same directory
+$ jbrowse make-pif input.paf
+
+# specify the output file, also creates output.pif.gz.tbi
+$ jbrowse make-pif input.paf --out output.pif.gz
+
+# use a CSI index for assemblies with chromosomes longer than ~512 Mb
+$ jbrowse make-pif input.paf --csi
+
+# emit an unsplit coarse tier (alongside the fine tier)
+$ jbrowse make-pif input.paf --coarse 0
+
+# emit only the per-row CIGAR fine tier, skipping the coarse tier
+$ jbrowse make-pif input.paf --no-coarse
 ```
 
 
 ## jbrowse sort-gff
 
 ```
-Helper utility to sort GFF files for tabix. Moves all lines starting with # to the top of the file, and sort by refname and start position using unix utilities sort and grep
+Sort a GFF or GTF for tabix — the two share a refname/start column layout. It is
+`sort -k1,1 -k4,4n` with LC_ALL=C and a tab separator, plus every line starting
+with # kept at the top rather than sorted into the data. Takes a file, or the
+same data on stdin
 
 Usage: jbrowse sort-gff [file] [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
+
+Examples:
 
 # sort gff and pipe to bgzip
 $ jbrowse sort-gff input.gff | bgzip > sorted.gff.gz
@@ -480,18 +695,26 @@ $ tabix sorted.gff.gz
 
 # sort gff from stdin
 $ cat input.gff | jbrowse sort-gff | bgzip > sorted.gff.gz
+
+# also works on GTF
+$ jbrowse sort-gff input.gtf | bgzip > sorted.gtf.gz
+$ tabix -p gff sorted.gtf.gz
 ```
 
 
 ## jbrowse sort-bed
 
 ```
-Helper utility to sort BED files for tabix. Moves all lines starting with # to the top of the file, and sort by refname and start position using unix utilities sort and grep
+Sort a BED file for tabix. It is `sort -k1,1 -k2,2n` with LC_ALL=C and a tab
+separator, plus every line starting with # kept at the top rather than sorted
+into the data. Takes a file, or the same data on stdin
 
 Usage: jbrowse sort-bed [file] [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
+
+Examples:
 
 # sort bed and pipe to bgzip
 $ jbrowse sort-bed input.bed | bgzip > sorted.bed.gz
@@ -509,7 +732,7 @@ Add a connection to a JBrowse 2 configuration
 Usage: jbrowse add-connection <connectionUrlOrPath> [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
   -t, --type                 Type of connection (e.g. JBrowse1Connection,
                              UCSCTrackHubConnection, custom)
@@ -532,18 +755,27 @@ Options:
 
       --out                  Synonym for target
 
-      --skipCheck            Don't check whether the data directory URL exists
+  -f, --force                Overwrite existing connection if one with the same
+                             id exists
+
+Examples:
+
+# add a JBrowse 1 data directory connection (type inferred from the jbrowse/data path)
+$ jbrowse add-connection https://mysite.com/jbrowse/data/ -a hg19
+
+# force the JBrowse1Connection type for a non-standard data folder path
+$ jbrowse add-connection https://mysite.com/jbrowse/custom_data_folder/ --type JBrowse1Connection -a hg38
+
+# add a UCSC track hub (type inferred from the hub.txt filename)
+$ jbrowse add-connection https://mysite.com/path/to/hub.txt
 
-      --overwrite            Overwrites any existing connections if same
-                             connection id
+# force the UCSCTrackHubConnection type for a hub file not named hub.txt
+$ jbrowse add-connection https://mysite.com/path/to/custom_hub_name.txt --type UCSCTrackHubConnection
 
-  -f, --force                Equivalent to --skipCheck --overwrite
+# add a custom connection type with extra config
+$ jbrowse add-connection https://mysite.com/path/to/custom --type custom --config '{"uri":{"url":"https://mysite.com/path/to/custom"}, "locationType": "UriLocation"}' -a hg19
 
-$ jbrowse add-connection http://mysite.com/jbrowse/data/ -a hg19
-$ jbrowse add-connection http://mysite.com/jbrowse/custom_data_folder/ --type JBrowse1Connection -a hg38
-$ jbrowse add-connection http://mysite.com/path/to/hub.txt
-$ jbrowse add-connection http://mysite.com/path/to/custom_hub_name.txt --type UCSCTrackHubConnection
-$ jbrowse add-connection http://mysite.com/path/to/custom --type custom --config '{"uri":{"url":"https://mysite.com/path/to/custom"}, "locationType": "UriLocation"}' -a hg19
+# set an explicit id/name and write to a specific config file
 $ jbrowse add-connection https://mysite.com/path/to/hub.txt --connectionId newId --name newName --target /path/to/jb2/installation/config.json
 ```
 
@@ -551,12 +783,13 @@ $ jbrowse add-connection https://mysite.com/path/to/hub.txt --connectionId newId
 ## jbrowse add-track-json
 
 ```
-Add a track configuration directly from a JSON hunk to the JBrowse 2 configuration
+Add a track configuration directly from a JSON hunk to the JBrowse 2
+configuration
 
 Usage: jbrowse add-track-json <track> [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
   -u, --update               Update the contents of an existing track, matched
                              based on trackId
@@ -566,27 +799,56 @@ Options:
 
       --out                  Synonym for target
 
+Notes:
+
+The track argument is a JSON file, inline JSON, or "-" to read the JSON from
+stdin, so a track config can be generated and piped straight in.
+
+Examples:
+
+# add a track from a JSON file
 $ jbrowse add-track-json track.json
+
+# update an existing track (matched by trackId) with new JSON contents
 $ jbrowse add-track-json track.json --update
+
+# pass the track config inline instead of via a file
+$ jbrowse add-track-json '{"type":"FeatureTrack","trackId":"genes","assemblyNames":["hg38"],"adapter":{"type":"Gff3TabixAdapter","gffGzLocation":{"uri":"genes.gff.gz"}}}'
+
+# pipe the track config in from another program
+$ jq '.tracks[0]' other/config.json | jbrowse add-track-json -
+
+# write to a config.json in a specific installation directory
+$ jbrowse add-track-json track.json --out /path/to/jb2/
 ```
 
 
 ## jbrowse remove-track
 
 ```
-Remove a track configuration from a JBrowse 2 configuration. Be aware that this can cause crashes in saved sessions that refer to this track!
+Remove a track configuration from a JBrowse 2 configuration. Be aware that this
+can cause crashes in saved sessions that refer to this track!
 
 Usage: jbrowse remove-track <trackId> [options]
 
 Options:
-  -h, --help                 
+  -h, --help                 Show help
 
       --target               Path to config file in JB2 installation directory
                              to write out to
 
       --out                  Synonym for target
 
-$ jbrowse remove-track trackId
+Examples:
+
+# remove a track from the config.json in the current directory
+$ jbrowse remove-track my_track_id
+
+# remove a track from a config.json in a specific installation directory
+$ jbrowse remove-track my_track_id --out /path/to/jb2/
+
+# remove a track from a specific config file
+$ jbrowse remove-track my_track_id --target /path/to/jb2/config.json
 ```
 
 
@@ -595,15 +857,16 @@ $ jbrowse remove-track trackId
 ```
 Set a default session with views and tracks
 
-Usage: jbrowse add-track <track> [options]
+Usage: jbrowse set-default-session [options]
 
 Options:
   -s, --session              set path to a file containing session in json
-                             format (required, unless using
-                             delete/currentSession flags)
+                             format, or "-" to read it from stdin (required,
+                             unless using delete/currentSession flags)
 
-  -n, --name                 Give a name for the default session [default: New
-                             Default Session]
+  -n, --name                 Give a name for the default session (overrides any
+                             name in the session file; defaults to "New Default
+                             Session")
 
   -c, --currentSession       List out the current default session
 
@@ -616,14 +879,25 @@ Options:
 
   -h, --help                 Show help
 
+Examples:
+
 # set default session for the config.json in your current directory
 $ jbrowse set-default-session --session /path/to/default/session.json
 
 # make session.json the defaultSession on the specified target config.json file
 $ jbrowse set-default-session --target /path/to/jb2/installation/config.json --session session.json
 
-# print current default session
-$ jbrowse set-default-session --currentSession # Prints out current default session
+# override the name stored in the session file
+$ jbrowse set-default-session --session session.json --name "My default view"
+
+# pipe a session in from another program
+$ jq '.defaultSession' other/config.json | jbrowse set-default-session --session -
+
+# print the current default session
+$ jbrowse set-default-session --currentSession
+
+# remove the existing default session
+$ jbrowse set-default-session --delete
 ```
 
 

package/bin/run

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
-
 import { main } from '../dist/index.js'
+
 main(process.argv.slice(2))