@apollo-annotation/cli 0.1.19 → 0.1.21

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.
Files changed (54) hide show
  1. package/README.md +297 -115
  2. package/dist/baseCommand.d.ts +1 -1
  3. package/dist/baseCommand.js +3 -4
  4. package/dist/commands/assembly/add-from-fasta.d.ts +22 -0
  5. package/dist/commands/assembly/add-from-fasta.js +157 -0
  6. package/dist/commands/assembly/{add-gff.d.ts → add-from-gff.d.ts} +5 -3
  7. package/dist/commands/assembly/add-from-gff.js +64 -0
  8. package/dist/commands/assembly/check.js +9 -9
  9. package/dist/commands/assembly/delete.js +4 -4
  10. package/dist/commands/assembly/get.js +4 -4
  11. package/dist/commands/assembly/sequence.js +4 -4
  12. package/dist/commands/change/get.js +7 -7
  13. package/dist/commands/config.js +4 -6
  14. package/dist/commands/feature/add-child.js +6 -5
  15. package/dist/commands/feature/check.js +6 -6
  16. package/dist/commands/feature/copy.js +5 -4
  17. package/dist/commands/feature/delete.js +4 -4
  18. package/dist/commands/feature/edit-attribute.js +6 -5
  19. package/dist/commands/feature/edit-coords.js +5 -5
  20. package/dist/commands/feature/edit-type.js +5 -5
  21. package/dist/commands/feature/edit.js +5 -5
  22. package/dist/commands/feature/get-id.js +5 -5
  23. package/dist/commands/feature/get.js +3 -3
  24. package/dist/commands/feature/import.d.ts +5 -3
  25. package/dist/commands/feature/import.js +15 -14
  26. package/dist/commands/feature/search.js +6 -6
  27. package/dist/commands/file/delete.d.ts +13 -0
  28. package/dist/commands/file/delete.js +58 -0
  29. package/dist/commands/file/download.d.ts +14 -0
  30. package/dist/commands/file/download.js +45 -0
  31. package/dist/commands/file/get.d.ts +13 -0
  32. package/dist/commands/file/get.js +38 -0
  33. package/dist/commands/file/upload.d.ts +18 -0
  34. package/dist/commands/file/upload.js +89 -0
  35. package/dist/commands/jbrowse/get-config.d.ts +10 -0
  36. package/dist/commands/jbrowse/get-config.js +21 -0
  37. package/dist/commands/jbrowse/set-config.d.ts +13 -0
  38. package/dist/commands/jbrowse/set-config.js +51 -0
  39. package/dist/commands/login.js +11 -15
  40. package/dist/commands/logout.js +2 -2
  41. package/dist/commands/refseq/add-alias.d.ts +3 -1
  42. package/dist/commands/refseq/add-alias.js +13 -12
  43. package/dist/commands/refseq/get.js +8 -8
  44. package/dist/commands/status.js +4 -3
  45. package/dist/commands/user/get.js +3 -3
  46. package/dist/fileCommand.d.ts +5 -0
  47. package/dist/fileCommand.js +76 -0
  48. package/dist/utils.d.ts +7 -21
  49. package/dist/utils.js +37 -109
  50. package/oclif.manifest.json +449 -90
  51. package/package.json +50 -43
  52. package/dist/commands/assembly/add-fasta.d.ts +0 -15
  53. package/dist/commands/assembly/add-fasta.js +0 -87
  54. package/dist/commands/assembly/add-gff.js +0 -63
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @apollo-annotation/cli
16
16
  $ apollo COMMAND
17
17
  running command...
18
18
  $ apollo (--version)
19
- @apollo-annotation/cli/0.1.19 linux-x64 node-v20.14.0
19
+ @apollo-annotation/cli/0.1.21 linux-x64 node-v18.20.4
20
20
  $ apollo --help [COMMAND]
21
21
  USAGE
22
22
  $ apollo COMMAND
@@ -29,8 +29,8 @@ USAGE
29
29
 
30
30
  <!-- commands -->
31
31
 
32
- - [`apollo assembly add-fasta`](#apollo-assembly-add-fasta)
33
- - [`apollo assembly add-gff`](#apollo-assembly-add-gff)
32
+ - [`apollo assembly add-from-fasta INPUT`](#apollo-assembly-add-from-fasta-input)
33
+ - [`apollo assembly add-from-gff INPUT-FILE`](#apollo-assembly-add-from-gff-input-file)
34
34
  - [`apollo assembly check`](#apollo-assembly-check)
35
35
  - [`apollo assembly delete`](#apollo-assembly-delete)
36
36
  - [`apollo assembly get`](#apollo-assembly-get)
@@ -47,61 +47,83 @@ USAGE
47
47
  - [`apollo feature edit-type`](#apollo-feature-edit-type)
48
48
  - [`apollo feature get`](#apollo-feature-get)
49
49
  - [`apollo feature get-id`](#apollo-feature-get-id)
50
- - [`apollo feature import`](#apollo-feature-import)
50
+ - [`apollo feature import INPUT-FILE`](#apollo-feature-import-input-file)
51
51
  - [`apollo feature search`](#apollo-feature-search)
52
+ - [`apollo file delete`](#apollo-file-delete)
53
+ - [`apollo file download`](#apollo-file-download)
54
+ - [`apollo file get`](#apollo-file-get)
55
+ - [`apollo file upload INPUT-FILE`](#apollo-file-upload-input-file)
52
56
  - [`apollo help [COMMANDS]`](#apollo-help-commands)
57
+ - [`apollo jbrowse get-config`](#apollo-jbrowse-get-config)
58
+ - [`apollo jbrowse set-config INPUTFILE`](#apollo-jbrowse-set-config-inputfile)
53
59
  - [`apollo login`](#apollo-login)
54
60
  - [`apollo logout`](#apollo-logout)
55
- - [`apollo refseq add-alias`](#apollo-refseq-add-alias)
61
+ - [`apollo refseq add-alias INPUT-FILE`](#apollo-refseq-add-alias-input-file)
56
62
  - [`apollo refseq get`](#apollo-refseq-get)
57
63
  - [`apollo status`](#apollo-status)
58
64
  - [`apollo user get`](#apollo-user-get)
59
65
 
60
- ## `apollo assembly add-fasta`
66
+ ## `apollo assembly add-from-fasta INPUT`
61
67
 
62
- Add new assembly from local or external fasta file
68
+ Add a new assembly from fasta input
63
69
 
64
70
  ```
65
71
  USAGE
66
- $ apollo assembly add-fasta -i <value> [--profile <value>] [--config-file <value>] [-a <value>] [-x <value>] [-f]
72
+ $ apollo assembly add-from-fasta INPUT [--profile <value>] [--config-file <value>] [-a <value>] [-f] [-e] [--fai <value>]
73
+ [--gzi <value>] [-z | -d]
74
+
75
+ ARGUMENTS
76
+ INPUT Input fasta file, local or remote, or id of a previously uploaded file. For local or remote files, it is
77
+ assumed the file is bgzip'd with `bgzip` and indexed with `samtools faidx`. The indexes are assumed to be at
78
+ <my.fasta.gz>.fai and <my.fasta.gz>.gzi unless the options --fai and --gzi are provided.
67
79
 
68
80
  FLAGS
69
81
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
82
+ -d, --decompressed For local file input: Override autodetection and instruct that input is decompressed
83
+ -e, --editable Instead of using indexed fasta lookup, the sequence is loaded into the Apollo database and
84
+ is editable. Use with caution, as editing the sequence often has unintended side effects.
70
85
  -f, --force Delete existing assembly, if it exists
71
- -i, --input-file=<value> (required) Input fasta file
72
- -x, --index=<value> URL of the index. Required if input is an external source and ignored if input is a local
73
- file
86
+ -z, --gzip For local file input: Override autodetection and instruct that input is gzip compressed
74
87
  --config-file=<value> Use this config file (mostly for testing)
88
+ --fai=<value> Fasta index of the (not-editable) fasta file
89
+ --gzi=<value> Gzi index of the (not-editable) fasta file
75
90
  --profile=<value> Use credentials from this profile
76
91
 
77
92
  DESCRIPTION
78
- Add new assembly from local or external fasta file
93
+ Add a new assembly from fasta input
94
+
95
+ Add new assembly. The input fasta may be:
96
+ * A local file
97
+ * An external fasta file
98
+ * The id of a file previously uploaded to Apollo
79
99
 
80
100
  EXAMPLES
81
101
  From local file:
82
102
 
83
- $ apollo assembly add-fasta -i genome.fa -a myAssembly
103
+ $ apollo assembly add-from-fasta genome.fa -a myAssembly
84
104
 
85
105
  From external source we also need the URL of the index:
86
106
 
87
- $ apollo assembly add-fasta -i https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly
107
+ $ apollo assembly add-from-fasta https://.../genome.fa -x https://.../genome.fa.fai -a myAssembly
88
108
  ```
89
109
 
90
110
  _See code:
91
- [src/commands/assembly/add-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/add-fasta.ts)_
111
+ [src/commands/assembly/add-from-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/add-from-fasta.ts)_
92
112
 
93
- ## `apollo assembly add-gff`
113
+ ## `apollo assembly add-from-gff INPUT-FILE`
94
114
 
95
115
  Add new assembly from gff or gft file
96
116
 
97
117
  ```
98
118
  USAGE
99
- $ apollo assembly add-gff -i <value> [--profile <value>] [--config-file <value>] [-a <value>] [-o] [-f]
119
+ $ apollo assembly add-from-gff INPUT-FILE [--profile <value>] [--config-file <value>] [-a <value>] [-o] [-f]
120
+
121
+ ARGUMENTS
122
+ INPUT-FILE Input gff file
100
123
 
101
124
  FLAGS
102
125
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
103
126
  -f, --force Delete existing assembly, if it exists
104
- -i, --input-file=<value> (required) Input gff or gtf file
105
127
  -o, --omit-features Do not import features, only upload the sequences
106
128
  --config-file=<value> Use this config file (mostly for testing)
107
129
  --profile=<value> Use credentials from this profile
@@ -109,21 +131,20 @@ FLAGS
109
131
  DESCRIPTION
110
132
  Add new assembly from gff or gft file
111
133
 
112
- The gff file is expected to contain sequences as per gff specifications.
113
- Features are also imported by default.
134
+ The gff file is expected to contain sequences as per gff specifications. Features are also imported by default.
114
135
 
115
136
  EXAMPLES
116
137
  Import sequences and features:
117
138
 
118
- $ apollo assembly add-gff -i genome.gff -a myAssembly
139
+ $ apollo assembly add-from-gff genome.gff -a myAssembly
119
140
 
120
141
  Import sequences only:
121
142
 
122
- $ apollo assembly add-gff -i genome.gff -a myAssembly -o
143
+ $ apollo assembly add-from-gff genome.gff -a myAssembly -o
123
144
  ```
124
145
 
125
146
  _See code:
126
- [src/commands/assembly/add-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/add-gff.ts)_
147
+ [src/commands/assembly/add-from-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/add-from-gff.ts)_
127
148
 
128
149
  ## `apollo assembly check`
129
150
 
@@ -143,9 +164,8 @@ FLAGS
143
164
  DESCRIPTION
144
165
  Add, view, or delete checks to assembly
145
166
 
146
- Manage checks, i.e. the rules ensuring features in an assembly are plausible.
147
- This command only sets the checks to apply, to retrieve features flagged by
148
- these checks use `apollo feature check`.
167
+ Manage checks, i.e. the rules ensuring features in an assembly are plausible. This command only sets the checks to
168
+ apply, to retrieve features flagged by these checks use `apollo feature check`.
149
169
 
150
170
  EXAMPLES
151
171
  View available check types:
@@ -166,7 +186,7 @@ EXAMPLES
166
186
  ```
167
187
 
168
188
  _See code:
169
- [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/check.ts)_
189
+ [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/check.ts)_
170
190
 
171
191
  ## `apollo assembly delete`
172
192
 
@@ -194,7 +214,7 @@ EXAMPLES
194
214
  ```
195
215
 
196
216
  _See code:
197
- [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/delete.ts)_
217
+ [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/delete.ts)_
198
218
 
199
219
  ## `apollo assembly get`
200
220
 
@@ -216,7 +236,7 @@ DESCRIPTION
216
236
  ```
217
237
 
218
238
  _See code:
219
- [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/get.ts)_
239
+ [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/get.ts)_
220
240
 
221
241
  ## `apollo assembly sequence`
222
242
 
@@ -251,7 +271,7 @@ EXAMPLES
251
271
  ```
252
272
 
253
273
  _See code:
254
- [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/assembly/sequence.ts)_
274
+ [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/assembly/sequence.ts)_
255
275
 
256
276
  ## `apollo change get`
257
277
 
@@ -269,14 +289,13 @@ FLAGS
269
289
  DESCRIPTION
270
290
  Get list of changes
271
291
 
272
- Return the change log in json format. Note that when an assembly is deleted the
273
- link between common name and ID is lost (it can still be recovered by inspecting
274
- the change log but at present this task is left to the user). In such cases you
275
- need to use the assembly ID.
292
+ Return the change log in json format. Note that when an assembly is deleted the link between common name and ID is
293
+ lost (it can still be recovered by inspecting the change log but at present this task is left to the user). In such
294
+ cases you need to use the assembly ID.
276
295
  ```
277
296
 
278
297
  _See code:
279
- [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/change/get.ts)_
298
+ [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/change/get.ts)_
280
299
 
281
300
  ## `apollo config [KEY] [VALUE]`
282
301
 
@@ -298,15 +317,14 @@ FLAGS
298
317
  DESCRIPTION
299
318
  Get or set apollo configuration options
300
319
 
301
- Use this command to create or edit a user profile with credentials to access
302
- Apollo. Configuration options are:
320
+ Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:
303
321
 
304
322
  - address:
305
323
  Address and port e.g http://localhost:3999
306
324
 
307
325
  - accessType:
308
- How to access Apollo. accessType is typically one of: google, microsoft, guest,
309
- root. Allowed types depend on your Apollo setup
326
+ How to access Apollo. accessType is typically one of: google, microsoft, guest, root. Allowed types depend on your
327
+ Apollo setup
310
328
 
311
329
  - accessToken:
312
330
  Access token. Usually inserted by `apollo login`
@@ -332,7 +350,7 @@ EXAMPLES
332
350
  ```
333
351
 
334
352
  _See code:
335
- [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/config.ts)_
353
+ [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/config.ts)_
336
354
 
337
355
  ## `apollo feature add-child`
338
356
 
@@ -353,17 +371,17 @@ FLAGS
353
371
  DESCRIPTION
354
372
  Add a child feature (e.g. add an exon to an mRNA)
355
373
 
356
- See the other commands under `apollo feature` to retrive the parent ID of
357
- interest and to populate the child feature with attributes.
374
+ See the other commands under `apollo feature` to retrive the parent ID of interest and to populate the child feature
375
+ with attributes.
358
376
 
359
377
  EXAMPLES
360
378
  Add an exon at genomic coordinates 10..20 to this feature ID:
361
379
 
362
- $ apollo feature add-child -i 6605826fbd0eee691f83e73f -t exon -s 10 -e 20
380
+ $ apollo feature add-child -i 660...73f -t exon -s 10 -e 20
363
381
  ```
364
382
 
365
383
  _See code:
366
- [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/add-child.ts)_
384
+ [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/add-child.ts)_
367
385
 
368
386
  ## `apollo feature check`
369
387
 
@@ -382,9 +400,8 @@ FLAGS
382
400
  DESCRIPTION
383
401
  Get check results
384
402
 
385
- Use this command to view which features fail checks along with the reason for
386
- failing. Use `apollo assembly check` for managing which checks should be applied
387
- to an assembly
403
+ Use this command to view which features fail checks along with the reason for failing.Use `apollo assembly check` for
404
+ managing which checks should be applied to an assembly
388
405
 
389
406
  EXAMPLES
390
407
  Get all check results in the database:
@@ -397,7 +414,7 @@ EXAMPLES
397
414
  ```
398
415
 
399
416
  _See code:
400
- [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/check.ts)_
417
+ [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/check.ts)_
401
418
 
402
419
  ## `apollo feature copy`
403
420
 
@@ -418,9 +435,8 @@ FLAGS
418
435
  DESCRIPTION
419
436
  Copy a feature to another location
420
437
 
421
- The feature may be copied to the same or to a different assembly. he destination
422
- reference sequence may be selected by name only if unique in the database or by
423
- name and assembly or by identifier.
438
+ The feature may be copied to the same or to a different assembly. The destination reference sequence may be selected
439
+ by name only if unique in the database or by name and assembly or by identifier.
424
440
 
425
441
  EXAMPLES
426
442
  Copy this feature ID to chr1:100 in assembly hg38:
@@ -429,7 +445,7 @@ EXAMPLES
429
445
  ```
430
446
 
431
447
  _See code:
432
- [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/copy.ts)_
448
+ [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/copy.ts)_
433
449
 
434
450
  ## `apollo feature delete`
435
451
 
@@ -449,12 +465,11 @@ FLAGS
449
465
  DESCRIPTION
450
466
  Delete one or more features by ID
451
467
 
452
- Note that deleting a child feature after deleting its parent will result in an
453
- error unless you set -f/--force.
468
+ Note that deleting a child feature after deleting its parent will result in an error unless you set -f/--force.
454
469
  ```
455
470
 
456
471
  _See code:
457
- [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/delete.ts)_
472
+ [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/delete.ts)_
458
473
 
459
474
  ## `apollo feature edit`
460
475
 
@@ -472,12 +487,11 @@ FLAGS
472
487
  DESCRIPTION
473
488
  Edit features using an appropiate json input
474
489
 
475
- Edit a feature by submitting a json input with all the required attributes for
476
- Apollo to process it. This is a very low level command which most users probably
477
- do not need.
490
+ Edit a feature by submitting a json input with all the required attributes for Apollo to process it. This is a very
491
+ low level command which most users probably do not need.
478
492
 
479
- Input may be a json string or a json file and it may be an array of changes.
480
- This is an example input for editing feature type:
493
+ Input may be a json string or a json file and it may be an array of changes. This is an example input for editing
494
+ feature type:
481
495
 
482
496
  {
483
497
  "typeName": "TypeChange",
@@ -497,7 +511,7 @@ EXAMPLES
497
511
  ```
498
512
 
499
513
  _See code:
500
- [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit.ts)_
514
+ [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/edit.ts)_
501
515
 
502
516
  ## `apollo feature edit-attribute`
503
517
 
@@ -519,9 +533,8 @@ FLAGS
519
533
  DESCRIPTION
520
534
  Add, edit, or view a feature attribute
521
535
 
522
- Be aware that there is no checking whether attributes names and values are
523
- valid. For example, you can create non-unique ID attributes or you can set gene
524
- ontology terms to non-existing terms
536
+ Be aware that there is no checking whether attributes names and values are valid. For example, you can create
537
+ non-unique ID attributes or you can set gene ontology terms to non-existing terms
525
538
 
526
539
  EXAMPLES
527
540
  Add attribute "domains" with a list of values:
@@ -538,7 +551,7 @@ EXAMPLES
538
551
  ```
539
552
 
540
553
  _See code:
541
- [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
554
+ [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
542
555
 
543
556
  ## `apollo feature edit-coords`
544
557
 
@@ -558,9 +571,8 @@ FLAGS
558
571
  DESCRIPTION
559
572
  Edit feature start and/or end coordinates
560
573
 
561
- If editing a child feature that new coordinates must be within the parent's
562
- coordinates. To get the identifier of the feature to edit consider using `apollo
563
- feature get` or `apollo feature search`
574
+ If editing a child feature that new coordinates must be within the parent's coordinates.To get the identifier of the
575
+ feature to edit consider using `apollo feature get` or `apollo feature search`
564
576
 
565
577
  EXAMPLES
566
578
  Edit start and end:
@@ -573,7 +585,7 @@ EXAMPLES
573
585
  ```
574
586
 
575
587
  _See code:
576
- [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
588
+ [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
577
589
 
578
590
  ## `apollo feature edit-type`
579
591
 
@@ -592,12 +604,12 @@ FLAGS
592
604
  DESCRIPTION
593
605
  Edit or view feature type
594
606
 
595
- Feature type is column 3 in gff format. It must be a valid sequence ontology
596
- term although but the valifdity of the new term is not checked.
607
+ Feature type is column 3 in gff format.It must be a valid sequence ontology term although but the valifdity of the new
608
+ term is not checked.
597
609
  ```
598
610
 
599
611
  _See code:
600
- [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/edit-type.ts)_
612
+ [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/edit-type.ts)_
601
613
 
602
614
  ## `apollo feature get`
603
615
 
@@ -624,14 +636,14 @@ EXAMPLES
624
636
 
625
637
  $ apollo feature get -a myAssembly
626
638
 
627
- Get features intersecting chr1:1..1000. You can omit the assembly name if there
628
- are no other reference sequences named chr1:
639
+ Get features intersecting chr1:1..1000. You can omit the assembly name if there are no other reference sequences
640
+ named chr1:
629
641
 
630
642
  $ apollo feature get -a myAssembly -r chr1 -s 1 -e 1000
631
643
  ```
632
644
 
633
645
  _See code:
634
- [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/get.ts)_
646
+ [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/get.ts)_
635
647
 
636
648
  ## `apollo feature get-id`
637
649
 
@@ -642,8 +654,7 @@ USAGE
642
654
  $ apollo feature get-id [--profile <value>] [--config-file <value>] [-i <value>]
643
655
 
644
656
  FLAGS
645
- -i, --feature-id=<value>... [default: -] Retrieves feature with these IDs. Use
646
- "-" to read IDs from stdin (one per
657
+ -i, --feature-id=<value>... [default: -] Retrieves feature with these IDs. Use "-" to read IDs from stdin (one per
647
658
  line)
648
659
  --config-file=<value> Use this config file (mostly for testing)
649
660
  --profile=<value> Use credentials from this profile
@@ -651,8 +662,7 @@ FLAGS
651
662
  DESCRIPTION
652
663
  Get features given their identifiers
653
664
 
654
- Invalid identifiers or identifiers not found in the database will be silently
655
- ignored
665
+ Invalid identifiers or identifiers not found in the database will be silently ignored
656
666
 
657
667
  EXAMPLES
658
668
  Get features for these identifiers:
@@ -661,20 +671,22 @@ EXAMPLES
661
671
  ```
662
672
 
663
673
  _See code:
664
- [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/get-id.ts)_
674
+ [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/get-id.ts)_
665
675
 
666
- ## `apollo feature import`
676
+ ## `apollo feature import INPUT-FILE`
667
677
 
668
678
  Import features from local gff file
669
679
 
670
680
  ```
671
681
  USAGE
672
- $ apollo feature import -i <value> -a <value> [--profile <value>] [--config-file <value>] [-d]
682
+ $ apollo feature import INPUT-FILE -a <value> [--profile <value>] [--config-file <value>] [-d]
683
+
684
+ ARGUMENTS
685
+ INPUT-FILE Input gff file
673
686
 
674
687
  FLAGS
675
688
  -a, --assembly=<value> (required) Import into this assembly name or assembly ID
676
689
  -d, --delete-existing Delete existing features before importing
677
- -i, --input-file=<value> (required) Input gff or gtf file
678
690
  --config-file=<value> Use this config file (mostly for testing)
679
691
  --profile=<value> Use credentials from this profile
680
692
 
@@ -686,11 +698,11 @@ DESCRIPTION
686
698
  EXAMPLES
687
699
  Delete features in myAssembly and then import features.gff3:
688
700
 
689
- $ apollo feature import -d -i features.gff3 -a myAssembly
701
+ $ apollo feature import features.gff3 -d -a myAssembly
690
702
  ```
691
703
 
692
704
  _See code:
693
- [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/import.ts)_
705
+ [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/import.ts)_
694
706
 
695
707
  ## `apollo feature search`
696
708
 
@@ -701,8 +713,8 @@ USAGE
701
713
  $ apollo feature search -t <value> [--profile <value>] [--config-file <value>] [-a <value>]
702
714
 
703
715
  FLAGS
704
- -a, --assembly=<value>... Assembly names or IDs to search; use "-" to read it from stdin. If omitted
705
- search all assemblies
716
+ -a, --assembly=<value>... Assembly names or IDs to search; use "-" to read it from stdin. If omitted search all
717
+ assemblies
706
718
  -t, --text=<value> (required) Search for this text query
707
719
  --config-file=<value> Use this config file (mostly for testing)
708
720
  --profile=<value> Use credentials from this profile
@@ -726,8 +738,7 @@ DESCRIPTION
726
738
 
727
739
  chr1 example SNP 10 30 0.987 . . "someKey=Fingerprint BAC with reads"
728
740
 
729
- Queries "bac" or "mRNA" return the feature. Instead these queries will NOT
730
- match:
741
+ Queries "bac" or "mRNA" return the feature. Instead these queries will NOT match:
731
742
 
732
743
  - "someKey"
733
744
  - "with"
@@ -742,7 +753,126 @@ EXAMPLES
742
753
  ```
743
754
 
744
755
  _See code:
745
- [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/feature/search.ts)_
756
+ [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/feature/search.ts)_
757
+
758
+ ## `apollo file delete`
759
+
760
+ Delete files from the Apollo server
761
+
762
+ ```
763
+ USAGE
764
+ $ apollo file delete [--profile <value>] [--config-file <value>] [-i <value>]
765
+
766
+ FLAGS
767
+ -i, --file-id=<value>... [default: -] IDs of the files to delete
768
+ --config-file=<value> Use this config file (mostly for testing)
769
+ --profile=<value> Use credentials from this profile
770
+
771
+ DESCRIPTION
772
+ Delete files from the Apollo server
773
+
774
+ Deleted files are printed to stdout. See also `apollo file get` to list the files on the server
775
+
776
+ EXAMPLES
777
+ Delete file multiple files:
778
+
779
+ $ apollo file delete -i 123...abc xyz...789
780
+ ```
781
+
782
+ _See code:
783
+ [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/delete.ts)_
784
+
785
+ ## `apollo file download`
786
+
787
+ Download a file from the Apollo server
788
+
789
+ ```
790
+ USAGE
791
+ $ apollo file download [--profile <value>] [--config-file <value>] [-i <value>] [-o <value>]
792
+
793
+ FLAGS
794
+ -i, --file-id=<value> [default: -] ID of the file to download
795
+ -o, --output=<value> Write output to this file or "-" for stdout. Default to the name of the uploaded file.
796
+ --config-file=<value> Use this config file (mostly for testing)
797
+ --profile=<value> Use credentials from this profile
798
+
799
+ DESCRIPTION
800
+ Download a file from the Apollo server
801
+
802
+ See also `apollo file get` to list the files on the server
803
+
804
+ EXAMPLES
805
+ Download file with id xyz
806
+
807
+ $ apollo file download -i xyz -o genome.fa
808
+ ```
809
+
810
+ _See code:
811
+ [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/download.ts)_
812
+
813
+ ## `apollo file get`
814
+
815
+ Get list of files uploaded to the Apollo server
816
+
817
+ ```
818
+ USAGE
819
+ $ apollo file get [--profile <value>] [--config-file <value>] [-i <value>]
820
+
821
+ FLAGS
822
+ -i, --file-id=<value>... Get files matching this IDs
823
+ --config-file=<value> Use this config file (mostly for testing)
824
+ --profile=<value> Use credentials from this profile
825
+
826
+ DESCRIPTION
827
+ Get list of files uploaded to the Apollo server
828
+
829
+ Print to stdout the list of files in json format
830
+
831
+ EXAMPLES
832
+ Get files by id:
833
+
834
+ $ apollo file get -i xyz abc
835
+ ```
836
+
837
+ _See code:
838
+ [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/get.ts)_
839
+
840
+ ## `apollo file upload INPUT-FILE`
841
+
842
+ Upload a local file to the Apollo server
843
+
844
+ ```
845
+ USAGE
846
+ $ apollo file upload INPUT-FILE [--profile <value>] [--config-file <value>] [-t
847
+ text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi] [-z | -d]
848
+
849
+ ARGUMENTS
850
+ INPUT-FILE Local file to upload
851
+
852
+ FLAGS
853
+ -d, --decompressed Override autodetection and instruct that input is decompressed
854
+ -t, --type=<option> Set file type or autodetected it if not set.
855
+ NB: There is no check for whether the file complies to this type
856
+ <options: text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi>
857
+ -z, --gzip Override autodetection and instruct that input is gzip compressed
858
+ --config-file=<value> Use this config file (mostly for testing)
859
+ --profile=<value> Use credentials from this profile
860
+
861
+ DESCRIPTION
862
+ Upload a local file to the Apollo server
863
+
864
+ This command only uploads a file and returns the corresponding file id.
865
+ To add an assembly based on this file or to upload & add an assembly in a single pass see `apollo assembly
866
+ add-from-fasta` and `add-from-gff`
867
+
868
+ EXAMPLES
869
+ Upload local file, type auto-detected:
870
+
871
+ $ apollo file upload genome.fa > file.json
872
+ ```
873
+
874
+ _See code:
875
+ [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/upload.ts)_
746
876
 
747
877
  ## `apollo help [COMMANDS]`
748
878
 
@@ -765,6 +895,61 @@ DESCRIPTION
765
895
  _See code:
766
896
  [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.8/src/commands/help.ts)_
767
897
 
898
+ ## `apollo jbrowse get-config`
899
+
900
+ Get JBrowse configuration from Apollo
901
+
902
+ ```
903
+ USAGE
904
+ $ apollo jbrowse get-config [--profile <value>] [--config-file <value>]
905
+
906
+ FLAGS
907
+ --config-file=<value> Use this config file (mostly for testing)
908
+ --profile=<value> Use credentials from this profile
909
+
910
+ DESCRIPTION
911
+ Get JBrowse configuration from Apollo
912
+
913
+ Print to stdout the JBrowse configuration from Apollo in JSON format
914
+
915
+ EXAMPLES
916
+ Get JBrowse configuration:
917
+
918
+ $ apollo jbrowse get-config > config.json
919
+ ```
920
+
921
+ _See code:
922
+ [src/commands/jbrowse/get-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/jbrowse/get-config.ts)_
923
+
924
+ ## `apollo jbrowse set-config INPUTFILE`
925
+
926
+ Set JBrowse configuration
927
+
928
+ ```
929
+ USAGE
930
+ $ apollo jbrowse set-config INPUTFILE [--profile <value>] [--config-file <value>]
931
+
932
+ ARGUMENTS
933
+ INPUTFILE JBrowse configuration file
934
+
935
+ FLAGS
936
+ --config-file=<value> Use this config file (mostly for testing)
937
+ --profile=<value> Use credentials from this profile
938
+
939
+ DESCRIPTION
940
+ Set JBrowse configuration
941
+
942
+ Set JBrowse configuration in Apollo collaboration server
943
+
944
+ EXAMPLES
945
+ Add JBrowse configuration:
946
+
947
+ $ apollo jbrowse set-config config.json
948
+ ```
949
+
950
+ _See code:
951
+ [src/commands/jbrowse/set-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/jbrowse/set-config.ts)_
952
+
768
953
  ## `apollo login`
769
954
 
770
955
  Login to Apollo
@@ -787,14 +972,12 @@ FLAGS
787
972
  DESCRIPTION
788
973
  Login to Apollo
789
974
 
790
- Use the provided credentials to obtain and save the token to access Apollo. Once
791
- the token for the given profile has been saved in the configuration file, users
792
- do not normally need to execute this command again unless the token has expired.
793
- To setup a new profile use "apollo config"
975
+ Use the provided credentials to obtain and save the token to access Apollo. Once the token for the given profile has
976
+ been saved in the configuration file, users do not normally need to execute this command again unless the token has
977
+ expired. To setup a new profile use "apollo config"
794
978
 
795
979
  EXAMPLES
796
- The most basic and probably most typical usage is to login using the default
797
- profile in configuration file:
980
+ The most basic and probably most typical usage is to login using the default profile in configuration file:
798
981
 
799
982
  $ apollo login
800
983
 
@@ -804,7 +987,7 @@ EXAMPLES
804
987
  ```
805
988
 
806
989
  _See code:
807
- [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/login.ts)_
990
+ [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/login.ts)_
808
991
 
809
992
  ## `apollo logout`
810
993
 
@@ -834,37 +1017,38 @@ EXAMPLES
834
1017
  ```
835
1018
 
836
1019
  _See code:
837
- [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/logout.ts)_
1020
+ [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/logout.ts)_
838
1021
 
839
- ## `apollo refseq add-alias`
1022
+ ## `apollo refseq add-alias INPUT-FILE`
840
1023
 
841
1024
  Add reference name aliases from a file
842
1025
 
843
1026
  ```
844
1027
  USAGE
845
- $ apollo refseq add-alias -i <value> -a <value> [--profile <value>] [--config-file <value>]
1028
+ $ apollo refseq add-alias INPUT-FILE -a <value> [--profile <value>] [--config-file <value>]
1029
+
1030
+ ARGUMENTS
1031
+ INPUT-FILE Input refname alias file
846
1032
 
847
1033
  FLAGS
848
1034
  -a, --assembly=<value> (required) Name for this assembly.
849
- -i, --input-file=<value> (required) Input refname alias file
850
1035
  --config-file=<value> Use this config file (mostly for testing)
851
1036
  --profile=<value> Use credentials from this profile
852
1037
 
853
1038
  DESCRIPTION
854
1039
  Add reference name aliases from a file
855
1040
 
856
- Reference name aliasing is a process to make chromosomes that are named slightly
857
- differently but which refer to the same thing render properly. This command
858
- reads a file with reference name aliases and adds them to the database.
1041
+ Reference name aliasing is a process to make chromosomes that are named slightly differently but which refer to the
1042
+ same thing render properly. This command reads a file with reference name aliases and adds them to the database.
859
1043
 
860
1044
  EXAMPLES
861
1045
  Add reference name aliases:
862
1046
 
863
- $ apollo refseq add-alias -i alias.txt -a myAssembly
1047
+ $ apollo refseq add-alias alias.txt -a myAssembly
864
1048
  ```
865
1049
 
866
1050
  _See code:
867
- [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
1051
+ [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
868
1052
 
869
1053
  ## `apollo refseq get`
870
1054
 
@@ -882,9 +1066,8 @@ FLAGS
882
1066
  DESCRIPTION
883
1067
  Get reference sequences
884
1068
 
885
- Output the reference sequences in one or more assemblies in json format. This
886
- command returns the sequence characteristics (e.g., name, ID, etc), not the DNA
887
- sequences. Use `assembly sequence` for that.
1069
+ Output the reference sequences in one or more assemblies in json format. This command returns the sequence
1070
+ characteristics (e.g., name, ID, etc), not the DNA sequences. Use `assembly sequence` for that.
888
1071
 
889
1072
  EXAMPLES
890
1073
  All sequences in the database:
@@ -897,7 +1080,7 @@ EXAMPLES
897
1080
  ```
898
1081
 
899
1082
  _See code:
900
- [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/refseq/get.ts)_
1083
+ [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/refseq/get.ts)_
901
1084
 
902
1085
  ## `apollo status`
903
1086
 
@@ -914,13 +1097,12 @@ FLAGS
914
1097
  DESCRIPTION
915
1098
  View authentication status
916
1099
 
917
- This command returns "<profile>: Logged in" if the selected profile has an
918
- access token and "<profile>: Logged out" otherwise. Note that this command does
919
- not check the validity of the access token.
1100
+ This command returns "<profile>: Logged in" if the selected profile has an access token and "<profile>: Logged out"
1101
+ otherwise.Note that this command does not check the validity of the access token.
920
1102
  ```
921
1103
 
922
1104
  _See code:
923
- [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/status.ts)_
1105
+ [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/status.ts)_
924
1106
 
925
1107
  ## `apollo user get`
926
1108
 
@@ -956,6 +1138,6 @@ EXAMPLES
956
1138
  ```
957
1139
 
958
1140
  _See code:
959
- [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.19/packages/apollo-cli/src/commands/user/get.ts)_
1141
+ [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/user/get.ts)_
960
1142
 
961
1143
  <!-- commandsstop -->