@jbrowse/cli 2.6.3 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +274 -206
- package/bin/dev +17 -0
- package/bin/dev.cmd +3 -0
- package/bin/run +6 -3
- package/lib/base.js +32 -80
- package/lib/commands/add-assembly.js +29 -27
- package/lib/commands/add-connection.js +43 -37
- package/lib/commands/add-track-json.js +9 -10
- package/lib/commands/add-track.js +74 -73
- package/lib/commands/admin-server.js +7 -7
- package/lib/commands/create.js +14 -16
- package/lib/commands/remove-track.js +9 -11
- package/lib/commands/set-default-session.js +14 -17
- package/lib/commands/text-index.js +86 -101
- package/lib/commands/upgrade.js +13 -14
- package/lib/fetchWithProxy.js +1 -1
- package/lib/index.js +2 -2
- package/lib/types/common.js +2 -2
- package/lib/types/gff3Adapter.js +54 -88
- package/lib/types/vcfAdapter.js +58 -93
- package/oclif.manifest.json +918 -1
- package/package.json +10 -12
package/README.md
CHANGED
|
@@ -53,7 +53,7 @@ It is likely preferable in most cases to install the tools globally with
|
|
|
53
53
|
- [`jbrowse add-track-json TRACK`](#jbrowse-add-track-json-track)
|
|
54
54
|
- [`jbrowse admin-server`](#jbrowse-admin-server)
|
|
55
55
|
- [`jbrowse create LOCALPATH`](#jbrowse-create-localpath)
|
|
56
|
-
- [`jbrowse help [
|
|
56
|
+
- [`jbrowse help [COMMANDS]`](#jbrowse-help-commands)
|
|
57
57
|
- [`jbrowse remove-track TRACK`](#jbrowse-remove-track-track)
|
|
58
58
|
- [`jbrowse set-default-session`](#jbrowse-set-default-session)
|
|
59
59
|
- [`jbrowse text-index`](#jbrowse-text-index)
|
|
@@ -65,7 +65,10 @@ Add an assembly to a JBrowse 2 configuration
|
|
|
65
65
|
|
|
66
66
|
```
|
|
67
67
|
USAGE
|
|
68
|
-
$ jbrowse add-assembly SEQUENCE
|
|
68
|
+
$ jbrowse add-assembly SEQUENCE [-t indexedFasta|bgzipFasta|twoBit|chromSizes|custom] [-n <value>] [-a <value>]
|
|
69
|
+
[--displayName <value>] [--faiLocation <value>] [--gziLocation <value>] [--refNameAliasesType aliases|custom
|
|
70
|
+
--refNameAliases <value>] [--refNameColors <value>] [--target <value>] [--out <value>] [-h] [-l
|
|
71
|
+
copy|symlink|move|inPlace] [--skipCheck] [--overwrite] [-f]
|
|
69
72
|
|
|
70
73
|
ARGUMENTS
|
|
71
74
|
SEQUENCE
|
|
@@ -76,8 +79,8 @@ ARGUMENTS
|
|
|
76
79
|
If TYPE is bgzipFasta, the gzip index file defaults to <location>.gzi and can be
|
|
77
80
|
optionally specified with --gziLocation
|
|
78
81
|
|
|
79
|
-
|
|
80
|
-
-a, --alias
|
|
82
|
+
FLAGS
|
|
83
|
+
-a, --alias=<value>...
|
|
81
84
|
An alias for the assembly name (e.g. "hg38" if the name of the assembly is "GRCh38");
|
|
82
85
|
can be specified multiple times
|
|
83
86
|
|
|
@@ -85,16 +88,17 @@ OPTIONS
|
|
|
85
88
|
Equivalent to `--skipCheck --overwrite`
|
|
86
89
|
|
|
87
90
|
-h, --help
|
|
88
|
-
|
|
91
|
+
Show CLI help.
|
|
89
92
|
|
|
90
|
-
-l, --load
|
|
93
|
+
-l, --load=<option>
|
|
91
94
|
Required flag when using a local file. Choose how to manage the data directory. Copy, symlink, or move the data
|
|
92
95
|
directory to the JBrowse directory. Or use inPlace to modify the config without doing any file operations
|
|
96
|
+
<options: copy|symlink|move|inPlace>
|
|
93
97
|
|
|
94
|
-
-n, --name
|
|
98
|
+
-n, --name=<value>
|
|
95
99
|
Name of the assembly; if not specified, will be guessed using the sequence file name
|
|
96
100
|
|
|
97
|
-
-t, --type
|
|
101
|
+
-t, --type=<option>
|
|
98
102
|
type of sequence, by default inferred from sequence file
|
|
99
103
|
|
|
100
104
|
indexedFasta An index FASTA (e.g. .fa or .fasta) file;
|
|
@@ -109,71 +113,97 @@ OPTIONS
|
|
|
109
113
|
|
|
110
114
|
custom Either a JSON file location or inline JSON that defines a custom
|
|
111
115
|
sequence adapter; must provide --name if using inline JSON
|
|
116
|
+
<options: indexedFasta|bgzipFasta|twoBit|chromSizes|custom>
|
|
112
117
|
|
|
113
|
-
--displayName
|
|
118
|
+
--displayName=<value>
|
|
114
119
|
The display name to specify for the assembly, e.g. "Homo sapiens (hg38)" while the name can be a shorter identifier
|
|
115
120
|
like "hg38"
|
|
116
121
|
|
|
117
|
-
--faiLocation
|
|
122
|
+
--faiLocation=<value>
|
|
118
123
|
[default: <fastaLocation>.fai] FASTA index file or URL
|
|
119
124
|
|
|
120
|
-
--gziLocation
|
|
125
|
+
--gziLocation=<value>
|
|
121
126
|
[default: <fastaLocation>.gzi] FASTA gzip index file or URL
|
|
122
127
|
|
|
123
|
-
--out
|
|
128
|
+
--out=<value>
|
|
124
129
|
synonym for target
|
|
125
130
|
|
|
126
131
|
--overwrite
|
|
127
132
|
Overwrite existing assembly if one with the same name exists
|
|
128
133
|
|
|
129
|
-
--refNameAliases
|
|
134
|
+
--refNameAliases=<value>
|
|
130
135
|
Reference sequence name aliases file or URL; assumed to be a tab-separated aliases
|
|
131
136
|
file unless --refNameAliasesType is specified
|
|
132
137
|
|
|
133
|
-
--refNameAliasesType
|
|
138
|
+
--refNameAliasesType=<option>
|
|
134
139
|
Type of aliases defined by --refNameAliases; if "custom", --refNameAliases is either
|
|
135
140
|
a JSON file location or inline JSON that defines a custom sequence adapter
|
|
141
|
+
<options: aliases|custom>
|
|
136
142
|
|
|
137
|
-
--refNameColors
|
|
143
|
+
--refNameColors=<value>
|
|
138
144
|
A comma-separated list of color strings for the reference sequence names; will cycle
|
|
139
145
|
through colors if there are fewer colors than sequences
|
|
140
146
|
|
|
141
147
|
--skipCheck
|
|
142
148
|
Don't check whether or not the sequence file or URL exists or if you are in a JBrowse directory
|
|
143
149
|
|
|
144
|
-
--target
|
|
150
|
+
--target=<value>
|
|
145
151
|
path to config file in JB2 installation directory to write out to.
|
|
146
152
|
Creates ./config.json if nonexistent
|
|
147
153
|
|
|
154
|
+
DESCRIPTION
|
|
155
|
+
Add an assembly to a JBrowse 2 configuration
|
|
156
|
+
|
|
148
157
|
EXAMPLES
|
|
149
|
-
# add assembly to installation in current directory. assumes .fai file also exists, and copies GRCh38.fa and
|
|
150
|
-
|
|
158
|
+
# add assembly to installation in current directory. assumes .fai file also exists, and copies GRCh38.fa and GRCh38.fa.fai to current directory
|
|
159
|
+
|
|
151
160
|
$ jbrowse add-assembly GRCh38.fa --load copy
|
|
152
161
|
|
|
162
|
+
|
|
163
|
+
|
|
153
164
|
# add assembly to a specific jb2 installation path using --out, and copies the .fa and .fa.fai file to /path/to/jb2
|
|
165
|
+
|
|
154
166
|
$ jbrowse add-assembly GRCh38.fa --out /path/to/jb2/ --load copy
|
|
155
167
|
|
|
168
|
+
|
|
169
|
+
|
|
156
170
|
# force indexedFasta for add-assembly without relying on file extension
|
|
171
|
+
|
|
157
172
|
$ jbrowse add-assembly GRCh38.xyz --type indexedFasta --load copy
|
|
158
173
|
|
|
174
|
+
|
|
175
|
+
|
|
159
176
|
# add displayName for an assembly
|
|
177
|
+
|
|
160
178
|
$ jbrowse add-assembly myFile.fa.gz --name hg38 --displayName "Homo sapiens (hg38)"
|
|
161
179
|
|
|
180
|
+
|
|
181
|
+
|
|
162
182
|
# use chrom.sizes file for assembly instead of a fasta file
|
|
183
|
+
|
|
163
184
|
$ jbrowse add-assembly GRCh38.chrom.sizes --load inPlace
|
|
164
185
|
|
|
186
|
+
|
|
187
|
+
|
|
165
188
|
# add assembly from preconfigured json file, expert option
|
|
189
|
+
|
|
166
190
|
$ jbrowse add-assembly GRCh38.config.json --load copy
|
|
167
191
|
|
|
192
|
+
|
|
193
|
+
|
|
168
194
|
# add assembly from a 2bit file, also note pointing direct to a URL so no --load flag needed
|
|
195
|
+
|
|
169
196
|
$ jbrowse add-assembly https://example.com/data/sample.2bit
|
|
170
197
|
|
|
198
|
+
|
|
199
|
+
|
|
171
200
|
# add a bgzip indexed fasta inferred by fa.gz extension. assumes .fa.gz.gzi and .fa.gz.fai files also exists
|
|
201
|
+
|
|
172
202
|
$ jbrowse add-assembly myfile.fa.gz --load copy
|
|
173
203
|
```
|
|
174
204
|
|
|
175
205
|
_See code:
|
|
176
|
-
[src/commands/add-assembly.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
206
|
+
[src/commands/add-assembly.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/add-assembly.ts)_
|
|
177
207
|
|
|
178
208
|
## `jbrowse add-connection CONNECTIONURLORPATH`
|
|
179
209
|
|
|
@@ -181,53 +211,50 @@ Add a connection to a JBrowse 2 configuration
|
|
|
181
211
|
|
|
182
212
|
```
|
|
183
213
|
USAGE
|
|
184
|
-
$ jbrowse add-connection CONNECTIONURLORPATH
|
|
214
|
+
$ jbrowse add-connection CONNECTIONURLORPATH [-t <value>] [-a <value>] [-c <value>] [--connectionId <value>] [-n
|
|
215
|
+
<value>] [--target <value>] [--out <value>] [-h] [--skipCheck] [--overwrite] [-f]
|
|
185
216
|
|
|
186
217
|
ARGUMENTS
|
|
187
218
|
CONNECTIONURLORPATH URL of data directory
|
|
188
219
|
For hub file, usually called hub.txt
|
|
189
220
|
For JBrowse 1, location of JB1 data directory similar to http://mysite.com/jbrowse/data/
|
|
190
221
|
|
|
191
|
-
|
|
192
|
-
-a, --assemblyNames
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
--
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
--overwrite Overwrites any existing connections if same connection id
|
|
212
|
-
|
|
213
|
-
--skipCheck Don't check whether or not the data directory URL exists or if you are in a JBrowse
|
|
214
|
-
directory
|
|
215
|
-
|
|
216
|
-
--target=target path to config file in JB2 installation directory to write out to.
|
|
222
|
+
FLAGS
|
|
223
|
+
-a, --assemblyNames=<value> For UCSC, optional: Comma separated list of assembly name(s) to filter from this
|
|
224
|
+
connection. For JBrowse: a single assembly name
|
|
225
|
+
-c, --config=<value> Any extra config settings to add to connection in JSON object format, such as
|
|
226
|
+
'{"uri":"url":"https://sample.com"}, "locationType": "UriLocation"}'
|
|
227
|
+
-f, --force Equivalent to `--skipCheck --overwrite`
|
|
228
|
+
-h, --help Show CLI help.
|
|
229
|
+
-n, --name=<value> Name of the connection. Defaults to connectionId if not provided
|
|
230
|
+
-t, --type=<value> type of connection, ex. JBrowse1Connection, UCSCTrackHubConnection, custom
|
|
231
|
+
--connectionId=<value> Id for the connection that must be unique to JBrowse. Defaults to
|
|
232
|
+
'connectionType-assemblyName-currentTime'
|
|
233
|
+
--out=<value> synonym for target
|
|
234
|
+
--overwrite Overwrites any existing connections if same connection id
|
|
235
|
+
--skipCheck Don't check whether or not the data directory URL exists or if you are in a JBrowse
|
|
236
|
+
directory
|
|
237
|
+
--target=<value> path to config file in JB2 installation directory to write out to.
|
|
238
|
+
|
|
239
|
+
DESCRIPTION
|
|
240
|
+
Add a connection to a JBrowse 2 configuration
|
|
217
241
|
|
|
218
242
|
EXAMPLES
|
|
219
243
|
$ jbrowse add-connection http://mysite.com/jbrowse/data/ -a hg19
|
|
244
|
+
|
|
220
245
|
$ jbrowse add-connection http://mysite.com/jbrowse/custom_data_folder/ --type JBrowse1Connection -a hg38
|
|
246
|
+
|
|
221
247
|
$ jbrowse add-connection http://mysite.com/path/to/hub.txt
|
|
248
|
+
|
|
222
249
|
$ jbrowse add-connection http://mysite.com/path/to/custom_hub_name.txt --type UCSCTrackHubConnection
|
|
223
|
-
|
|
224
|
-
'{"uri":{"url":"https://mysite.com/path/to/custom"}, "locationType": "UriLocation"}' -a hg19
|
|
225
|
-
|
|
226
|
-
/path/to/jb2/installation/config.json
|
|
250
|
+
|
|
251
|
+
$ jbrowse add-connection http://mysite.com/path/to/custom --type custom --config '{"uri":{"url":"https://mysite.com/path/to/custom"}, "locationType": "UriLocation"}' -a hg19
|
|
252
|
+
|
|
253
|
+
$ jbrowse add-connection https://mysite.com/path/to/hub.txt --connectionId newId --name newName --target /path/to/jb2/installation/config.json
|
|
227
254
|
```
|
|
228
255
|
|
|
229
256
|
_See code:
|
|
230
|
-
[src/commands/add-connection.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
257
|
+
[src/commands/add-connection.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/add-connection.ts)_
|
|
231
258
|
|
|
232
259
|
## `jbrowse add-track TRACK`
|
|
233
260
|
|
|
@@ -235,78 +262,80 @@ Add a track to a JBrowse 2 configuration
|
|
|
235
262
|
|
|
236
263
|
```
|
|
237
264
|
USAGE
|
|
238
|
-
$ jbrowse add-track TRACK
|
|
265
|
+
$ jbrowse add-track TRACK [-t <value>] [-n <value>] [--indexFile <value>] [-d <value>] [-a <value>]
|
|
266
|
+
[--category <value>] [--config <value>] [--target <value>] [--out <value>] [--subDir <value>] [-h] [--trackId
|
|
267
|
+
<value>] [-l copy|symlink|move|inPlace] [--skipCheck] [--overwrite] [-f] [--protocol <value>] [--bed1 <value>]
|
|
268
|
+
[--bed2 <value>]
|
|
239
269
|
|
|
240
270
|
ARGUMENTS
|
|
241
271
|
TRACK Track file or URL
|
|
242
272
|
|
|
243
|
-
|
|
244
|
-
-a, --assemblyNames
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
-
|
|
248
|
-
|
|
249
|
-
-
|
|
273
|
+
FLAGS
|
|
274
|
+
-a, --assemblyNames=<value> Assembly name or names for track as comma separated string. If none, will default to the
|
|
275
|
+
assembly in your config file
|
|
276
|
+
-d, --description=<value> Optional description of the track
|
|
277
|
+
-f, --force Equivalent to `--skipCheck --overwrite`
|
|
278
|
+
-h, --help Show CLI help.
|
|
279
|
+
-l, --load=<option> Required flag when using a local file. Choose how to manage the track. Copy, symlink, or
|
|
280
|
+
move the track to the JBrowse directory. Or inPlace to leave track alone
|
|
281
|
+
<options: copy|symlink|move|inPlace>
|
|
282
|
+
-n, --name=<value> Name of the track. Will be defaulted to the trackId if none specified
|
|
283
|
+
-t, --trackType=<value> Type of track, by default inferred from track file
|
|
284
|
+
--bed1=<value> Used only for mcscan anchors/simpleAnchors types
|
|
285
|
+
--bed2=<value> Used only for mcscan anchors/simpleAnchors types
|
|
286
|
+
--category=<value> Optional Comma separated string of categories to group tracks
|
|
287
|
+
--config=<value> Any extra config settings to add to a track. i.e '{"defaultRendering": "density"}'
|
|
288
|
+
--indexFile=<value> Optional index file for the track
|
|
289
|
+
--out=<value> synonym for target
|
|
290
|
+
--overwrite Overwrites existing track if it shares the same trackId
|
|
291
|
+
--protocol=<value> [default: uri] Force protocol to a specific value
|
|
292
|
+
--skipCheck Skip check for whether or not the file or URL exists or if you are in a JBrowse directory
|
|
293
|
+
--subDir=<value> when using --load a file, output to a subdirectory of the target dir
|
|
294
|
+
--target=<value> path to config file in JB2 installation to write out to.
|
|
295
|
+
--trackId=<value> trackId for the track, by default inferred from filename, must be unique throughout
|
|
296
|
+
config
|
|
297
|
+
|
|
298
|
+
DESCRIPTION
|
|
299
|
+
Add a track to a JBrowse 2 configuration
|
|
250
300
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
-l, --load=copy|symlink|move|inPlace Required flag when using a local file. Choose how to manage the track. Copy,
|
|
254
|
-
symlink, or move the track to the JBrowse directory. Or inPlace to leave track
|
|
255
|
-
alone
|
|
301
|
+
EXAMPLES
|
|
302
|
+
# copy /path/to/my.bam and /path/to/my.bam.bai to current directory and adds track to config.json
|
|
256
303
|
|
|
257
|
-
|
|
304
|
+
$ jbrowse add-track /path/to/my.bam --load copy
|
|
258
305
|
|
|
259
|
-
-t, --trackType=trackType Type of track, by default inferred from track file
|
|
260
306
|
|
|
261
|
-
--bed1=bed1 Used only for mcscan anchors/simpleAnchors types
|
|
262
307
|
|
|
263
|
-
|
|
308
|
+
# copy my.bam and my.bam.bai to /path/to/jb2/bam and adds track entry to /path/to/jb2/bam/config.json
|
|
264
309
|
|
|
265
|
-
|
|
310
|
+
$ jbrowse add-track my.bam --load copy --out /path/to/jb2 --subDir bam
|
|
266
311
|
|
|
267
|
-
--config=config Any extra config settings to add to a track. i.e '{"defaultRendering":
|
|
268
|
-
"density"}'
|
|
269
312
|
|
|
270
|
-
--indexFile=indexFile Optional index file for the track
|
|
271
313
|
|
|
272
|
-
|
|
314
|
+
# same as above, but specify path to bai file. needed for if the bai file does not have the extension .bam.bai
|
|
273
315
|
|
|
274
|
-
|
|
316
|
+
$ jbrowse add-track my.bam --indexFile my.bai --load copy
|
|
275
317
|
|
|
276
|
-
--protocol=protocol [default: uri] Force protocol to a specific value
|
|
277
318
|
|
|
278
|
-
--skipCheck Skip check for whether or not the file or URL exists or if you are in a JBrowse
|
|
279
|
-
directory
|
|
280
319
|
|
|
281
|
-
|
|
320
|
+
# creates symlink for /path/to/my.bam and adds track to config.json
|
|
282
321
|
|
|
283
|
-
|
|
322
|
+
$ jbrowse add-track /path/to/my.bam --load symlink
|
|
284
323
|
|
|
285
|
-
--trackId=trackId trackId for the track, by default inferred from filename, must be unique
|
|
286
|
-
throughout config
|
|
287
324
|
|
|
288
|
-
EXAMPLES
|
|
289
|
-
# copy /path/to/my.bam and /path/to/my.bam.bai to current directory and adds track to config.json
|
|
290
|
-
$ jbrowse add-track /path/to/my.bam --load copy
|
|
291
325
|
|
|
292
|
-
#
|
|
293
|
-
$ jbrowse add-track my.bam --load copy --out /path/to/jb2 --subDir bam
|
|
326
|
+
# add track from URL to config.json, no --load flag needed
|
|
294
327
|
|
|
295
|
-
|
|
296
|
-
$ jbrowse add-track my.bam --indexFile my.bai --load copy
|
|
328
|
+
$ jbrowse add-track https://mywebsite.com/my.bam
|
|
297
329
|
|
|
298
|
-
# creates symlink for /path/to/my.bam and adds track to config.json
|
|
299
|
-
$ jbrowse add-track /path/to/my.bam --load symlink
|
|
300
330
|
|
|
301
|
-
# add track from URL to config.json, no --load flag needed
|
|
302
|
-
$ jbrowse add-track https://mywebsite.com/my.bam
|
|
303
331
|
|
|
304
332
|
# --load inPlace adds a track without doing file operations
|
|
333
|
+
|
|
305
334
|
$ jbrowse add-track /url/relative/path.bam --load inPlace
|
|
306
335
|
```
|
|
307
336
|
|
|
308
337
|
_See code:
|
|
309
|
-
[src/commands/add-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
338
|
+
[src/commands/add-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/add-track.ts)_
|
|
310
339
|
|
|
311
340
|
## `jbrowse add-track-json TRACK`
|
|
312
341
|
|
|
@@ -315,25 +344,28 @@ configuration
|
|
|
315
344
|
|
|
316
345
|
```
|
|
317
346
|
USAGE
|
|
318
|
-
$ jbrowse add-track-json TRACK
|
|
347
|
+
$ jbrowse add-track-json TRACK [-u] [--target <value>] [--out <value>]
|
|
319
348
|
|
|
320
349
|
ARGUMENTS
|
|
321
350
|
TRACK track JSON file or command line arg blob
|
|
322
351
|
|
|
323
|
-
|
|
324
|
-
-u, --update
|
|
325
|
-
--out
|
|
352
|
+
FLAGS
|
|
353
|
+
-u, --update update the contents of an existing track, matched based on trackId
|
|
354
|
+
--out=<value> synonym for target
|
|
355
|
+
--target=<value> path to config file in JB2 installation directory to write out to.
|
|
356
|
+
Creates ./config.json if nonexistent
|
|
326
357
|
|
|
327
|
-
|
|
328
|
-
|
|
358
|
+
DESCRIPTION
|
|
359
|
+
Add a track configuration directly from a JSON hunk to the JBrowse 2 configuration
|
|
329
360
|
|
|
330
361
|
EXAMPLES
|
|
331
362
|
$ jbrowse add-track-json track.json
|
|
363
|
+
|
|
332
364
|
$ jbrowse add-track-json track.json --update
|
|
333
365
|
```
|
|
334
366
|
|
|
335
367
|
_See code:
|
|
336
|
-
[src/commands/add-track-json.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
368
|
+
[src/commands/add-track-json.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/add-track-json.ts)_
|
|
337
369
|
|
|
338
370
|
## `jbrowse admin-server`
|
|
339
371
|
|
|
@@ -341,30 +373,30 @@ Start up a small admin server for JBrowse configuration
|
|
|
341
373
|
|
|
342
374
|
```
|
|
343
375
|
USAGE
|
|
344
|
-
$ jbrowse admin-server
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
-h, --help
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
--
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
rootDir/path/to/subconfig.json
|
|
376
|
+
$ jbrowse admin-server [-p <value>] [--root <value>] [--bodySizeLimit <value>] [-h]
|
|
377
|
+
|
|
378
|
+
FLAGS
|
|
379
|
+
-h, --help Show CLI help.
|
|
380
|
+
-p, --port=<value> Specifified port to start the server on;
|
|
381
|
+
Default is 9090.
|
|
382
|
+
--bodySizeLimit=<value> [default: 25mb] Size limit of the update message; may need to increase if config is large.
|
|
383
|
+
Argument is passed to bytes library for parsing: https://www.npmjs.com/package/bytes.
|
|
384
|
+
--root=<value> path to the root of the JB2 installation.
|
|
385
|
+
Creates ./config.json if nonexistent. note that you can navigate to
|
|
386
|
+
?config=path/to/subconfig.json in the web browser and it will write to
|
|
387
|
+
rootDir/path/to/subconfig.json
|
|
388
|
+
|
|
389
|
+
DESCRIPTION
|
|
390
|
+
Start up a small admin server for JBrowse configuration
|
|
360
391
|
|
|
361
392
|
EXAMPLES
|
|
362
393
|
$ jbrowse admin-server
|
|
394
|
+
|
|
363
395
|
$ jbrowse admin-server -p 8888
|
|
364
396
|
```
|
|
365
397
|
|
|
366
398
|
_See code:
|
|
367
|
-
[src/commands/admin-server.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
399
|
+
[src/commands/admin-server.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/admin-server.ts)_
|
|
368
400
|
|
|
369
401
|
## `jbrowse create LOCALPATH`
|
|
370
402
|
|
|
@@ -372,62 +404,77 @@ Downloads and installs the latest JBrowse 2 release
|
|
|
372
404
|
|
|
373
405
|
```
|
|
374
406
|
USAGE
|
|
375
|
-
$ jbrowse create LOCALPATH
|
|
407
|
+
$ jbrowse create LOCALPATH [-h] [-f] [-l] [--branch <value>] [--nightly] [-u <value>] [-t <value>]
|
|
376
408
|
|
|
377
409
|
ARGUMENTS
|
|
378
410
|
LOCALPATH Location where JBrowse 2 will be installed
|
|
379
411
|
|
|
380
|
-
|
|
412
|
+
FLAGS
|
|
381
413
|
-f, --force Overwrites existing JBrowse 2 installation if present in path
|
|
382
|
-
-h, --help
|
|
414
|
+
-h, --help Show CLI help.
|
|
383
415
|
-l, --listVersions Lists out all versions of JBrowse 2
|
|
384
|
-
|
|
385
|
-
-t, --tag=tag Version of JBrowse 2 to install. Format is v1.0.0.
|
|
416
|
+
-t, --tag=<value> Version of JBrowse 2 to install. Format is v1.0.0.
|
|
386
417
|
Defaults to latest
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
--branch=branch Download a development build from a named git branch
|
|
391
|
-
|
|
418
|
+
-u, --url=<value> A direct URL to a JBrowse 2 release
|
|
419
|
+
--branch=<value> Download a development build from a named git branch
|
|
392
420
|
--nightly Download the latest development build from the main branch
|
|
393
421
|
|
|
422
|
+
DESCRIPTION
|
|
423
|
+
Downloads and installs the latest JBrowse 2 release
|
|
424
|
+
|
|
394
425
|
EXAMPLES
|
|
395
426
|
# Download latest release from github, and put in specific path
|
|
427
|
+
|
|
396
428
|
$ jbrowse create /path/to/new/installation
|
|
397
429
|
|
|
430
|
+
|
|
431
|
+
|
|
398
432
|
# Download latest release from github and force overwrite existing contents at path
|
|
433
|
+
|
|
399
434
|
$ jbrowse create /path/to/new/installation --force
|
|
400
435
|
|
|
436
|
+
|
|
437
|
+
|
|
401
438
|
# Download latest release from a specific URL
|
|
439
|
+
|
|
402
440
|
$ jbrowse create /path/to/new/installation --url url.com/directjbrowselink.zip
|
|
403
441
|
|
|
442
|
+
|
|
443
|
+
|
|
404
444
|
# Download a specific tag from github
|
|
445
|
+
|
|
405
446
|
$ jbrowse create /path/to/new/installation --tag v1.0.0
|
|
406
447
|
|
|
448
|
+
|
|
449
|
+
|
|
407
450
|
# List available versions
|
|
451
|
+
|
|
408
452
|
$ jbrowse create --listVersions
|
|
409
453
|
```
|
|
410
454
|
|
|
411
455
|
_See code:
|
|
412
|
-
[src/commands/create.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
456
|
+
[src/commands/create.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/create.ts)_
|
|
413
457
|
|
|
414
|
-
## `jbrowse help [
|
|
458
|
+
## `jbrowse help [COMMANDS]`
|
|
415
459
|
|
|
416
|
-
|
|
460
|
+
Display help for jbrowse.
|
|
417
461
|
|
|
418
462
|
```
|
|
419
463
|
USAGE
|
|
420
|
-
$ jbrowse help [
|
|
464
|
+
$ jbrowse help [COMMANDS] [-n]
|
|
421
465
|
|
|
422
466
|
ARGUMENTS
|
|
423
|
-
|
|
467
|
+
COMMANDS Command to show help for.
|
|
468
|
+
|
|
469
|
+
FLAGS
|
|
470
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
424
471
|
|
|
425
|
-
|
|
426
|
-
|
|
472
|
+
DESCRIPTION
|
|
473
|
+
Display help for jbrowse.
|
|
427
474
|
```
|
|
428
475
|
|
|
429
476
|
_See code:
|
|
430
|
-
[@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
477
|
+
[@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
|
|
431
478
|
|
|
432
479
|
## `jbrowse remove-track TRACK`
|
|
433
480
|
|
|
@@ -436,23 +483,26 @@ can cause crashes in saved sessions that refer to this track!
|
|
|
436
483
|
|
|
437
484
|
```
|
|
438
485
|
USAGE
|
|
439
|
-
$ jbrowse remove-track TRACK
|
|
486
|
+
$ jbrowse remove-track TRACK [--target <value>] [--out <value>]
|
|
440
487
|
|
|
441
488
|
ARGUMENTS
|
|
442
489
|
TRACK track JSON file or command line arg blob
|
|
443
490
|
|
|
444
|
-
|
|
445
|
-
--out
|
|
491
|
+
FLAGS
|
|
492
|
+
--out=<value> synonym for target
|
|
493
|
+
--target=<value> path to config file in JB2 installation directory to write out to.
|
|
494
|
+
Creates ./config.json if nonexistent
|
|
446
495
|
|
|
447
|
-
|
|
448
|
-
|
|
496
|
+
DESCRIPTION
|
|
497
|
+
Remove a track configuration from a JBrowse 2 configuration. Be aware that this can cause crashes in saved sessions
|
|
498
|
+
that refer to this track!
|
|
449
499
|
|
|
450
|
-
|
|
500
|
+
EXAMPLES
|
|
451
501
|
$ jbrowse remove-track-json trackId
|
|
452
502
|
```
|
|
453
503
|
|
|
454
504
|
_See code:
|
|
455
|
-
[src/commands/remove-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
505
|
+
[src/commands/remove-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/remove-track.ts)_
|
|
456
506
|
|
|
457
507
|
## `jbrowse set-default-session`
|
|
458
508
|
|
|
@@ -460,37 +510,38 @@ Set a default session with views and tracks
|
|
|
460
510
|
|
|
461
511
|
```
|
|
462
512
|
USAGE
|
|
463
|
-
$ jbrowse set-default-session
|
|
513
|
+
$ jbrowse set-default-session [-s <value>] [-n <value>] [-v <value>] [--viewId <value>] [-t <value>] [-c] [--target
|
|
514
|
+
<value>] [--out <value>] [--delete] [-h]
|
|
464
515
|
|
|
465
|
-
|
|
516
|
+
FLAGS
|
|
466
517
|
-c, --currentSession List out the current default session
|
|
467
|
-
-h, --help
|
|
468
|
-
-n, --name
|
|
469
|
-
-s, --session
|
|
470
|
-
-t, --tracks
|
|
471
|
-
|
|
472
|
-
-v, --view=view View type in config to be added as default session, i.e LinearGenomeView, CircularView,
|
|
518
|
+
-h, --help Show CLI help.
|
|
519
|
+
-n, --name=<value> [default: New Default Session] Give a name for the default session
|
|
520
|
+
-s, --session=<value> set path to a file containing session in json format
|
|
521
|
+
-t, --tracks=<value> Track id or track ids as comma separated string to put into default session
|
|
522
|
+
-v, --view=<value> View type in config to be added as default session, i.e LinearGenomeView, CircularView,
|
|
473
523
|
DotplotView.
|
|
474
524
|
Must be provided if no default session file provided
|
|
475
|
-
|
|
476
525
|
--delete Delete any existing default session.
|
|
526
|
+
--out=<value> synonym for target
|
|
527
|
+
--target=<value> path to config file in JB2 installation directory to write out to
|
|
528
|
+
--viewId=<value> Identifier for the view. Will be generated on default
|
|
477
529
|
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
--target=target path to config file in JB2 installation directory to write out to
|
|
481
|
-
|
|
482
|
-
--viewId=viewId Identifier for the view. Will be generated on default
|
|
530
|
+
DESCRIPTION
|
|
531
|
+
Set a default session with views and tracks
|
|
483
532
|
|
|
484
533
|
EXAMPLES
|
|
485
534
|
$ jbrowse set-default-session --session /path/to/default/session.json
|
|
486
|
-
|
|
487
|
-
track2, track3
|
|
535
|
+
|
|
536
|
+
$ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1, track2, track3
|
|
537
|
+
|
|
488
538
|
$ jbrowse set-default-session --view LinearGenomeView, --name newName --viewId view-no-tracks
|
|
539
|
+
|
|
489
540
|
$ jbrowse set-default-session --currentSession # Prints out current default session
|
|
490
541
|
```
|
|
491
542
|
|
|
492
543
|
_See code:
|
|
493
|
-
[src/commands/set-default-session.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
544
|
+
[src/commands/set-default-session.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/set-default-session.ts)_
|
|
494
545
|
|
|
495
546
|
## `jbrowse text-index`
|
|
496
547
|
|
|
@@ -498,63 +549,66 @@ Make a text-indexing file for any given track(s).
|
|
|
498
549
|
|
|
499
550
|
```
|
|
500
551
|
USAGE
|
|
501
|
-
$ jbrowse text-index
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
552
|
+
$ jbrowse text-index [-h] [--tracks <value>] [--target <value>] [--out <value>] [--attributes <value>] [-a
|
|
553
|
+
<value>] [--force] [-q] [--perTrack] [--exclude <value>] [--prefixSize <value>] [--file <value>] [--fileId <value>]
|
|
554
|
+
[--dryrun]
|
|
555
|
+
|
|
556
|
+
FLAGS
|
|
557
|
+
-a, --assemblies=<value> Specify the assembl(ies) to create an index for. If unspecified, creates an index for each
|
|
558
|
+
assembly in the config
|
|
559
|
+
-h, --help Show CLI help.
|
|
560
|
+
-q, --quiet Hide the progress bars
|
|
561
|
+
--attributes=<value> [default: Name,ID] Comma separated list of attributes to index
|
|
562
|
+
--dryrun Just print out tracks that will be indexed by the process, without doing any indexing
|
|
563
|
+
--exclude=<value> [default: CDS,exon] Adds gene type to list of excluded types
|
|
564
|
+
--file=<value>... File or files to index (can be used to create trix indexes for embedded component use cases
|
|
565
|
+
not using a config.json for example)
|
|
566
|
+
--fileId=<value>... Set the trackId used for the indexes generated with the --file argument
|
|
567
|
+
--force Overwrite previously existing indexes
|
|
568
|
+
--out=<value> Synonym for target
|
|
569
|
+
--perTrack If set, creates an index per track
|
|
570
|
+
--prefixSize=<value> Specify the prefix size for the ixx index. We attempt to automatically calculate this, but
|
|
571
|
+
you can manually specify this too. If many genes have similar gene IDs e.g. Z000000001,
|
|
572
|
+
Z000000002 the prefix size should be larger so that they get split into different bins
|
|
573
|
+
--target=<value> Path to config file in JB2 installation directory to read from.
|
|
574
|
+
--tracks=<value> Specific tracks to index, formatted as comma separated trackIds. If unspecified, indexes all
|
|
575
|
+
available tracks
|
|
576
|
+
|
|
577
|
+
DESCRIPTION
|
|
578
|
+
Make a text-indexing file for any given track(s).
|
|
508
579
|
|
|
509
|
-
|
|
580
|
+
EXAMPLES
|
|
581
|
+
# indexes all tracks that it can find in the current directory's config.json
|
|
510
582
|
|
|
511
|
-
|
|
583
|
+
$ jbrowse text-index
|
|
512
584
|
|
|
513
|
-
--dryrun Just print out tracks that will be indexed by the process, without doing any indexing
|
|
514
585
|
|
|
515
|
-
--exclude=exclude [default: CDS,exon] Adds gene type to list of excluded types
|
|
516
586
|
|
|
517
|
-
|
|
518
|
-
cases not using a config.json for example)
|
|
587
|
+
# indexes specific trackIds that it can find in the current directory's config.json
|
|
519
588
|
|
|
520
|
-
|
|
589
|
+
$ jbrowse text-index --tracks=track1,track2,track3
|
|
521
590
|
|
|
522
|
-
--force Overwrite previously existing indexes
|
|
523
591
|
|
|
524
|
-
--out=out Synonym for target
|
|
525
592
|
|
|
526
|
-
|
|
593
|
+
# indexes all tracks in a directory's config.json or in a specific config file
|
|
527
594
|
|
|
528
|
-
|
|
529
|
-
but you can manually specify this too. If many genes have similar gene IDs e.g.
|
|
530
|
-
Z000000001, Z000000002 the prefix size should be larger so that they get split into
|
|
531
|
-
different bins
|
|
595
|
+
$ jbrowse text-index --out /path/to/jb2/
|
|
532
596
|
|
|
533
|
-
--target=target Path to config file in JB2 installation directory to read from.
|
|
534
597
|
|
|
535
|
-
--tracks=tracks Specific tracks to index, formatted as comma separated trackIds. If unspecified, indexes
|
|
536
|
-
all available tracks
|
|
537
598
|
|
|
538
|
-
|
|
539
|
-
# indexes all tracks that it can find in the current directory's config.json
|
|
540
|
-
$ jbrowse text-index
|
|
599
|
+
# indexes only a specific assembly, and overwrite what was previously there using force (which is needed if a previous index already existed)
|
|
541
600
|
|
|
542
|
-
|
|
543
|
-
$ jbrowse text-index --tracks=track1,track2,track3
|
|
601
|
+
$ jbrowse text-index -a hg19 --force
|
|
544
602
|
|
|
545
|
-
# indexes all tracks in a directory's config.json or in a specific config file
|
|
546
|
-
$ jbrowse text-index --out /path/to/jb2/
|
|
547
603
|
|
|
548
|
-
# indexes only a specific assembly, and overwrite what was previously there using force (which is needed if a previous
|
|
549
|
-
index already existed)
|
|
550
|
-
$ jbrowse text-index -a hg19 --force
|
|
551
604
|
|
|
552
605
|
# create index for some files for use in @jbrowse/react-linear-genome-view or similar
|
|
606
|
+
|
|
553
607
|
$ jbrowse text-index --file myfile.gff3.gz --file myfile.vcfgz --out indexes
|
|
554
608
|
```
|
|
555
609
|
|
|
556
610
|
_See code:
|
|
557
|
-
[src/commands/text-index.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
611
|
+
[src/commands/text-index.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/text-index.ts)_
|
|
558
612
|
|
|
559
613
|
## `jbrowse upgrade [LOCALPATH]`
|
|
560
614
|
|
|
@@ -562,48 +616,62 @@ Upgrades JBrowse 2 to latest version
|
|
|
562
616
|
|
|
563
617
|
```
|
|
564
618
|
USAGE
|
|
565
|
-
$ jbrowse upgrade [LOCALPATH]
|
|
619
|
+
$ jbrowse upgrade [LOCALPATH] [-h] [-l] [-t <value>] [--branch <value>] [--nightly] [--clean] [-u <value>]
|
|
566
620
|
|
|
567
621
|
ARGUMENTS
|
|
568
622
|
LOCALPATH [default: .] Location where JBrowse 2 is installed
|
|
569
623
|
|
|
570
|
-
|
|
571
|
-
-h, --help
|
|
624
|
+
FLAGS
|
|
625
|
+
-h, --help Show CLI help.
|
|
572
626
|
-l, --listVersions Lists out all versions of JBrowse 2
|
|
573
|
-
|
|
574
|
-
-t, --tag=tag Version of JBrowse 2 to install. Format is v1.0.0.
|
|
627
|
+
-t, --tag=<value> Version of JBrowse 2 to install. Format is v1.0.0.
|
|
575
628
|
Defaults to latest
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
--branch=branch Download a development build from a named git branch
|
|
580
|
-
|
|
629
|
+
-u, --url=<value> A direct URL to a JBrowse 2 release
|
|
630
|
+
--branch=<value> Download a development build from a named git branch
|
|
581
631
|
--clean Removes old js,map,and LICENSE files in the installation
|
|
582
|
-
|
|
583
632
|
--nightly Download the latest development build from the main branch
|
|
584
633
|
|
|
634
|
+
DESCRIPTION
|
|
635
|
+
Upgrades JBrowse 2 to latest version
|
|
636
|
+
|
|
585
637
|
EXAMPLES
|
|
586
638
|
# Upgrades current directory to latest jbrowse release
|
|
639
|
+
|
|
587
640
|
$ jbrowse upgrade
|
|
588
641
|
|
|
642
|
+
|
|
643
|
+
|
|
589
644
|
# Upgrade jbrowse instance at a specific filesystem path
|
|
645
|
+
|
|
590
646
|
$ jbrowse upgrade /path/to/jbrowse2/installation
|
|
591
647
|
|
|
648
|
+
|
|
649
|
+
|
|
592
650
|
# Upgrade to a specific tag
|
|
651
|
+
|
|
593
652
|
$ jbrowse upgrade /path/to/jbrowse2/installation --tag v1.0.0
|
|
594
653
|
|
|
654
|
+
|
|
655
|
+
|
|
595
656
|
# List versions available on github
|
|
657
|
+
|
|
596
658
|
$ jbrowse upgrade --listVersions
|
|
597
659
|
|
|
660
|
+
|
|
661
|
+
|
|
598
662
|
# Upgrade from a specific URL
|
|
663
|
+
|
|
599
664
|
$ jbrowse upgrade --url https://sample.com/jbrowse2.zip
|
|
600
665
|
|
|
666
|
+
|
|
667
|
+
|
|
601
668
|
# Get nightly release from main branch
|
|
669
|
+
|
|
602
670
|
$ jbrowse upgrade --nightly
|
|
603
671
|
```
|
|
604
672
|
|
|
605
673
|
_See code:
|
|
606
|
-
[src/commands/upgrade.ts](https://github.com/GMOD/jbrowse-components/blob/v2.
|
|
674
|
+
[src/commands/upgrade.ts](https://github.com/GMOD/jbrowse-components/blob/v2.7.0/products/jbrowse-cli/src/commands/upgrade.ts)_
|
|
607
675
|
|
|
608
676
|
<!-- commandsstop -->
|
|
609
677
|
|