@apollo-annotation/cli 0.1.20 → 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.
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.20 linux-x64 node-v18.20.4
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
@@ -47,18 +47,18 @@ 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
52
  - [`apollo file delete`](#apollo-file-delete)
53
53
  - [`apollo file download`](#apollo-file-download)
54
54
  - [`apollo file get`](#apollo-file-get)
55
- - [`apollo file upload`](#apollo-file-upload)
55
+ - [`apollo file upload INPUT-FILE`](#apollo-file-upload-input-file)
56
56
  - [`apollo help [COMMANDS]`](#apollo-help-commands)
57
57
  - [`apollo jbrowse get-config`](#apollo-jbrowse-get-config)
58
58
  - [`apollo jbrowse set-config INPUTFILE`](#apollo-jbrowse-set-config-inputfile)
59
59
  - [`apollo login`](#apollo-login)
60
60
  - [`apollo logout`](#apollo-logout)
61
- - [`apollo refseq add-alias`](#apollo-refseq-add-alias)
61
+ - [`apollo refseq add-alias INPUT-FILE`](#apollo-refseq-add-alias-input-file)
62
62
  - [`apollo refseq get`](#apollo-refseq-get)
63
63
  - [`apollo status`](#apollo-status)
64
64
  - [`apollo user get`](#apollo-user-get)
@@ -69,21 +69,20 @@ Add a new assembly from fasta input
69
69
 
70
70
  ```
71
71
  USAGE
72
- $ apollo assembly add-from-fasta INPUT [--profile <value>] [--config-file <value>] [-a <value>] [-x <value>] [-f] [-n]
73
- [--fai <value>] [--gzi <value>] [-z | -d]
72
+ $ apollo assembly add-from-fasta INPUT [--profile <value>] [--config-file <value>] [-a <value>] [-f] [-e] [--fai <value>]
73
+ [--gzi <value>] [-z | -d]
74
74
 
75
75
  ARGUMENTS
76
- INPUT Input fasta file, local or remote, or id of a previously uploaded file
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.
77
79
 
78
80
  FLAGS
79
81
  -a, --assembly=<value> Name for this assembly. Use the file name if omitted
80
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.
81
85
  -f, --force Delete existing assembly, if it exists
82
- -n, --not-editable The fasta sequence is not editable. Apollo will not load it into the database and instead
83
- use the provided indexes to query it. This option assumes the fasta file is bgzip'd with
84
- `bgzip` and indexed with `samtools faidx`. Indexes should be named <my.fasta.gz>.gzi and
85
- <my.fasta.gz>.fai unless options --fai and --gzi are set
86
- -x, --index=<value> URL of the index. Required if input is an external source
87
86
  -z, --gzip For local file input: Override autodetection and instruct that input is gzip compressed
88
87
  --config-file=<value> Use this config file (mostly for testing)
89
88
  --fai=<value> Fasta index of the (not-editable) fasta file
@@ -109,7 +108,7 @@ EXAMPLES
109
108
  ```
110
109
 
111
110
  _See code:
112
- [src/commands/assembly/add-from-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/add-from-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)_
113
112
 
114
113
  ## `apollo assembly add-from-gff INPUT-FILE`
115
114
 
@@ -137,7 +136,7 @@ DESCRIPTION
137
136
  EXAMPLES
138
137
  Import sequences and features:
139
138
 
140
- $ apollo assembly add-from-gff -i genome.gff -a myAssembly
139
+ $ apollo assembly add-from-gff genome.gff -a myAssembly
141
140
 
142
141
  Import sequences only:
143
142
 
@@ -145,7 +144,7 @@ EXAMPLES
145
144
  ```
146
145
 
147
146
  _See code:
148
- [src/commands/assembly/add-from-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/assembly/add-from-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)_
149
148
 
150
149
  ## `apollo assembly check`
151
150
 
@@ -187,7 +186,7 @@ EXAMPLES
187
186
  ```
188
187
 
189
188
  _See code:
190
- [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
191
190
 
192
191
  ## `apollo assembly delete`
193
192
 
@@ -215,7 +214,7 @@ EXAMPLES
215
214
  ```
216
215
 
217
216
  _See code:
218
- [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
219
218
 
220
219
  ## `apollo assembly get`
221
220
 
@@ -237,7 +236,7 @@ DESCRIPTION
237
236
  ```
238
237
 
239
238
  _See code:
240
- [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
241
240
 
242
241
  ## `apollo assembly sequence`
243
242
 
@@ -272,7 +271,7 @@ EXAMPLES
272
271
  ```
273
272
 
274
273
  _See code:
275
- [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
276
275
 
277
276
  ## `apollo change get`
278
277
 
@@ -296,7 +295,7 @@ DESCRIPTION
296
295
  ```
297
296
 
298
297
  _See code:
299
- [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
300
299
 
301
300
  ## `apollo config [KEY] [VALUE]`
302
301
 
@@ -351,7 +350,7 @@ EXAMPLES
351
350
  ```
352
351
 
353
352
  _See code:
354
- [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
355
354
 
356
355
  ## `apollo feature add-child`
357
356
 
@@ -382,7 +381,7 @@ EXAMPLES
382
381
  ```
383
382
 
384
383
  _See code:
385
- [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
386
385
 
387
386
  ## `apollo feature check`
388
387
 
@@ -415,7 +414,7 @@ EXAMPLES
415
414
  ```
416
415
 
417
416
  _See code:
418
- [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
419
418
 
420
419
  ## `apollo feature copy`
421
420
 
@@ -446,7 +445,7 @@ EXAMPLES
446
445
  ```
447
446
 
448
447
  _See code:
449
- [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
450
449
 
451
450
  ## `apollo feature delete`
452
451
 
@@ -470,7 +469,7 @@ DESCRIPTION
470
469
  ```
471
470
 
472
471
  _See code:
473
- [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
474
473
 
475
474
  ## `apollo feature edit`
476
475
 
@@ -512,7 +511,7 @@ EXAMPLES
512
511
  ```
513
512
 
514
513
  _See code:
515
- [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
516
515
 
517
516
  ## `apollo feature edit-attribute`
518
517
 
@@ -552,7 +551,7 @@ EXAMPLES
552
551
  ```
553
552
 
554
553
  _See code:
555
- [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
556
555
 
557
556
  ## `apollo feature edit-coords`
558
557
 
@@ -586,7 +585,7 @@ EXAMPLES
586
585
  ```
587
586
 
588
587
  _See code:
589
- [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
590
589
 
591
590
  ## `apollo feature edit-type`
592
591
 
@@ -610,7 +609,7 @@ DESCRIPTION
610
609
  ```
611
610
 
612
611
  _See code:
613
- [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
614
613
 
615
614
  ## `apollo feature get`
616
615
 
@@ -644,7 +643,7 @@ EXAMPLES
644
643
  ```
645
644
 
646
645
  _See code:
647
- [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
648
647
 
649
648
  ## `apollo feature get-id`
650
649
 
@@ -672,20 +671,22 @@ EXAMPLES
672
671
  ```
673
672
 
674
673
  _See code:
675
- [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
676
675
 
677
- ## `apollo feature import`
676
+ ## `apollo feature import INPUT-FILE`
678
677
 
679
678
  Import features from local gff file
680
679
 
681
680
  ```
682
681
  USAGE
683
- $ 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
684
686
 
685
687
  FLAGS
686
688
  -a, --assembly=<value> (required) Import into this assembly name or assembly ID
687
689
  -d, --delete-existing Delete existing features before importing
688
- -i, --input-file=<value> (required) Input gff file
689
690
  --config-file=<value> Use this config file (mostly for testing)
690
691
  --profile=<value> Use credentials from this profile
691
692
 
@@ -697,11 +698,11 @@ DESCRIPTION
697
698
  EXAMPLES
698
699
  Delete features in myAssembly and then import features.gff3:
699
700
 
700
- $ apollo feature import -d -i features.gff3 -a myAssembly
701
+ $ apollo feature import features.gff3 -d -a myAssembly
701
702
  ```
702
703
 
703
704
  _See code:
704
- [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
705
706
 
706
707
  ## `apollo feature search`
707
708
 
@@ -752,7 +753,7 @@ EXAMPLES
752
753
  ```
753
754
 
754
755
  _See code:
755
- [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
756
757
 
757
758
  ## `apollo file delete`
758
759
 
@@ -779,7 +780,7 @@ EXAMPLES
779
780
  ```
780
781
 
781
782
  _See code:
782
- [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/delete.ts)_
783
+ [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/delete.ts)_
783
784
 
784
785
  ## `apollo file download`
785
786
 
@@ -807,7 +808,7 @@ EXAMPLES
807
808
  ```
808
809
 
809
810
  _See code:
810
- [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/download.ts)_
811
+ [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/download.ts)_
811
812
 
812
813
  ## `apollo file get`
813
814
 
@@ -834,20 +835,22 @@ EXAMPLES
834
835
  ```
835
836
 
836
837
  _See code:
837
- [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/get.ts)_
838
+ [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/get.ts)_
838
839
 
839
- ## `apollo file upload`
840
+ ## `apollo file upload INPUT-FILE`
840
841
 
841
842
  Upload a local file to the Apollo server
842
843
 
843
844
  ```
844
845
  USAGE
845
- $ apollo file upload -i <value> [--profile <value>] [--config-file <value>] [-t
846
+ $ apollo file upload INPUT-FILE [--profile <value>] [--config-file <value>] [-t
846
847
  text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi] [-z | -d]
847
848
 
849
+ ARGUMENTS
850
+ INPUT-FILE Local file to upload
851
+
848
852
  FLAGS
849
853
  -d, --decompressed Override autodetection and instruct that input is decompressed
850
- -i, --input-file=<value> (required) Local file to upload
851
854
  -t, --type=<option> Set file type or autodetected it if not set.
852
855
  NB: There is no check for whether the file complies to this type
853
856
  <options: text/x-fasta|text/x-gff3|application/x-bgzip-fasta|text/x-fai|application/x-gzi>
@@ -865,11 +868,11 @@ DESCRIPTION
865
868
  EXAMPLES
866
869
  Upload local file, type auto-detected:
867
870
 
868
- $ apollo file upload -i genome.fa > file.json
871
+ $ apollo file upload genome.fa > file.json
869
872
  ```
870
873
 
871
874
  _See code:
872
- [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/file/upload.ts)_
875
+ [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.1.21/packages/apollo-cli/src/commands/file/upload.ts)_
873
876
 
874
877
  ## `apollo help [COMMANDS]`
875
878
 
@@ -916,7 +919,7 @@ EXAMPLES
916
919
  ```
917
920
 
918
921
  _See code:
919
- [src/commands/jbrowse/get-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/jbrowse/get-config.ts)_
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)_
920
923
 
921
924
  ## `apollo jbrowse set-config INPUTFILE`
922
925
 
@@ -945,7 +948,7 @@ EXAMPLES
945
948
  ```
946
949
 
947
950
  _See code:
948
- [src/commands/jbrowse/set-config.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/packages/apollo-cli/src/commands/jbrowse/set-config.ts)_
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)_
949
952
 
950
953
  ## `apollo login`
951
954
 
@@ -984,7 +987,7 @@ EXAMPLES
984
987
  ```
985
988
 
986
989
  _See code:
987
- [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
988
991
 
989
992
  ## `apollo logout`
990
993
 
@@ -1014,19 +1017,21 @@ EXAMPLES
1014
1017
  ```
1015
1018
 
1016
1019
  _See code:
1017
- [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
1018
1021
 
1019
- ## `apollo refseq add-alias`
1022
+ ## `apollo refseq add-alias INPUT-FILE`
1020
1023
 
1021
1024
  Add reference name aliases from a file
1022
1025
 
1023
1026
  ```
1024
1027
  USAGE
1025
- $ 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
1026
1032
 
1027
1033
  FLAGS
1028
1034
  -a, --assembly=<value> (required) Name for this assembly.
1029
- -i, --input-file=<value> (required) Input refname alias file
1030
1035
  --config-file=<value> Use this config file (mostly for testing)
1031
1036
  --profile=<value> Use credentials from this profile
1032
1037
 
@@ -1039,11 +1044,11 @@ DESCRIPTION
1039
1044
  EXAMPLES
1040
1045
  Add reference name aliases:
1041
1046
 
1042
- $ apollo refseq add-alias -i alias.txt -a myAssembly
1047
+ $ apollo refseq add-alias alias.txt -a myAssembly
1043
1048
  ```
1044
1049
 
1045
1050
  _See code:
1046
- [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
1047
1052
 
1048
1053
  ## `apollo refseq get`
1049
1054
 
@@ -1075,7 +1080,7 @@ EXAMPLES
1075
1080
  ```
1076
1081
 
1077
1082
  _See code:
1078
- [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
1079
1084
 
1080
1085
  ## `apollo status`
1081
1086
 
@@ -1097,7 +1102,7 @@ DESCRIPTION
1097
1102
  ```
1098
1103
 
1099
1104
  _See code:
1100
- [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
1101
1106
 
1102
1107
  ## `apollo user get`
1103
1108
 
@@ -1133,6 +1138,6 @@ EXAMPLES
1133
1138
  ```
1134
1139
 
1135
1140
  _See code:
1136
- [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.1.20/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)_
1137
1142
 
1138
1143
  <!-- commandsstop -->
@@ -11,9 +11,8 @@ export default class AddFasta extends FileCommand {
11
11
  };
12
12
  static flags: {
13
13
  assembly: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
14
- index: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
15
14
  force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
16
- 'not-editable': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
15
+ editable: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
17
16
  fai: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
18
17
  gzi: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
19
18
  gzip: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
@@ -8,7 +8,7 @@ import { queryApollo, submitAssembly } from '../../utils.js';
8
8
  export default class AddFasta extends FileCommand {
9
9
  static summary = 'Add a new assembly from fasta input';
10
10
  static description = `Add new assembly. The input fasta may be:
11
- * A local file
11
+ * A local file
12
12
  * An external fasta file
13
13
  * The id of a file previously uploaded to Apollo`;
14
14
  static examples = [
@@ -23,7 +23,11 @@ export default class AddFasta extends FileCommand {
23
23
  ];
24
24
  static args = {
25
25
  input: Args.string({
26
- description: 'Input fasta file, local or remote, or id of a previously uploaded file',
26
+ description: "Input fasta file, local or remote, or id of a previously uploaded \
27
+ file. For local or remote files, it is assumed the file is bgzip'd with \
28
+ `bgzip` and indexed with `samtools faidx`. The indexes are assumed to be at \
29
+ <my.fasta.gz>.fai and <my.fasta.gz>.gzi unless the options --fai and --gzi are \
30
+ provided.",
27
31
  required: true,
28
32
  }),
29
33
  };
@@ -32,20 +36,15 @@ export default class AddFasta extends FileCommand {
32
36
  char: 'a',
33
37
  description: 'Name for this assembly. Use the file name if omitted',
34
38
  }),
35
- index: Flags.string({
36
- char: 'x',
37
- description: 'URL of the index. Required if input is an external source',
38
- }),
39
39
  force: Flags.boolean({
40
40
  char: 'f',
41
41
  description: 'Delete existing assembly, if it exists',
42
42
  }),
43
- 'not-editable': Flags.boolean({
44
- char: 'n',
45
- description: "The fasta sequence is not editable. Apollo will not load it into \
46
- the database and instead use the provided indexes to query it. This option assumes \
47
- the fasta file is bgzip'd with `bgzip` and indexed with `samtools faidx`. \
48
- Indexes should be named <my.fasta.gz>.gzi and <my.fasta.gz>.fai unless options --fai and --gzi are set",
43
+ editable: Flags.boolean({
44
+ char: 'e',
45
+ description: 'Instead of using indexed fasta lookup, the sequence is loaded into \
46
+ the Apollo database and is editable. Use with caution, as editing the sequence \
47
+ often has unintended side effects.',
49
48
  }),
50
49
  fai: Flags.string({
51
50
  description: 'Fasta index of the (not-editable) fasta file',
@@ -65,27 +64,44 @@ Indexes should be named <my.fasta.gz>.gzi and <my.fasta.gz>.fai unless options -
65
64
  }),
66
65
  };
67
66
  async run() {
68
- const { args } = await this.parse(AddFasta);
69
- const { flags } = await this.parse(AddFasta);
67
+ const { args, flags } = await this.parse(AddFasta);
70
68
  const access = await this.getAccess();
71
69
  const assemblyName = flags.assembly ?? path.basename(args.input);
72
70
  const fastaIsFileId = await isFileId(args.input, access.address, access.accessToken);
73
71
  const isExternal = isValidHttpUrl(args.input);
74
72
  let body;
75
73
  if (isExternal) {
76
- if (flags.index === undefined) {
77
- this.error('Please provide the URL to the index of the external fasta file');
78
- }
74
+ const fai = flags.fai ?? `${args.input}.fai`;
75
+ const gzi = flags.gzi ?? `${args.input}.gzi`;
79
76
  body = {
80
77
  assemblyName,
81
78
  typeName: 'AddAssemblyFromExternalChange',
82
- externalLocation: {
83
- fa: args.input,
84
- fai: flags.index,
85
- },
79
+ externalLocation: { fa: args.input, fai, gzi },
80
+ assembly: new ObjectId().toHexString(),
81
+ };
82
+ }
83
+ else if (flags.editable) {
84
+ if (!isExternal && !fs.existsSync(args.input) && !fastaIsFileId) {
85
+ this.error(`Input "${args.input}" is not valid`);
86
+ }
87
+ let isGzip = args.input.endsWith('.gz');
88
+ if (flags.gzip) {
89
+ isGzip = true;
90
+ }
91
+ if (flags.decompressed) {
92
+ isGzip = false;
93
+ }
94
+ const fileId = fastaIsFileId
95
+ ? args.input
96
+ : await this.uploadFile(access.address, access.accessToken, args.input, 'text/x-fasta', isGzip);
97
+ body = {
98
+ assemblyName,
99
+ fileIds: { fa: fileId },
100
+ typeName: 'AddAssemblyFromFileChange',
101
+ assembly: new ObjectId().toHexString(),
86
102
  };
87
103
  }
88
- else if (flags['not-editable']) {
104
+ else {
89
105
  const gzi = flags.gzi ?? `${args.input}.gzi`;
90
106
  const fai = flags.fai ?? `${args.input}.fai`;
91
107
  const gziIsFileId = await isFileId(gzi, access.address, access.accessToken);
@@ -108,31 +124,7 @@ Indexes should be named <my.fasta.gz>.gzi and <my.fasta.gz>.fai unless options -
108
124
  body = {
109
125
  assemblyName,
110
126
  typeName: 'AddAssemblyFromFileChange',
111
- fileIds: {
112
- fa: faId,
113
- fai: faiId,
114
- gzi: gziId,
115
- },
116
- };
117
- }
118
- else {
119
- if (!isExternal && !fs.existsSync(args.input) && !fastaIsFileId) {
120
- this.error(`Input "${args.input}" is not valid`);
121
- }
122
- let isGzip = args.input.endsWith('.gz');
123
- if (flags.gzip) {
124
- isGzip = true;
125
- }
126
- if (flags.decompressed) {
127
- isGzip = false;
128
- }
129
- const fileId = fastaIsFileId
130
- ? args.input
131
- : await this.uploadFile(access.address, access.accessToken, args.input, 'text/x-fasta', isGzip);
132
- body = {
133
- assemblyName,
134
- fileIds: { fa: fileId },
135
- typeName: 'AddAssemblyFromFileChange',
127
+ fileIds: { fa: faId, fai: faiId, gzi: gziId },
136
128
  assembly: new ObjectId().toHexString(),
137
129
  };
138
130
  }
@@ -10,7 +10,7 @@ export default class AddGff extends FileCommand {
10
10
  static examples = [
11
11
  {
12
12
  description: 'Import sequences and features:',
13
- command: '<%= config.bin %> <%= command.id %> -i genome.gff -a myAssembly',
13
+ command: '<%= config.bin %> <%= command.id %> genome.gff -a myAssembly',
14
14
  },
15
15
  {
16
16
  description: 'Import sequences only:',
@@ -38,24 +38,26 @@ export default class AddGff extends FileCommand {
38
38
  }),
39
39
  };
40
40
  async run() {
41
- const { args } = await this.parse(AddGff);
42
- const { flags } = await this.parse(AddGff);
41
+ const { args, flags } = await this.parse(AddGff);
43
42
  if (!fs.existsSync(args['input-file'])) {
44
43
  this.error(`File ${args['input-file']} does not exist`);
45
44
  }
46
45
  const access = await this.getAccess();
47
46
  const fileId = await this.uploadFile(access.address, access.accessToken, args['input-file'], 'text/x-gff3', args['input-file'].endsWith('.gz'));
48
- let typeName = 'AddAssemblyAndFeaturesFromFileChange';
49
- if (flags['omit-features']) {
50
- typeName = 'AddAssemblyFromFileChange';
51
- }
52
47
  const assemblyName = flags.assembly ?? path.basename(args['input-file']);
53
- const body = {
54
- assemblyName,
55
- fileIds: { fa: fileId },
56
- typeName,
57
- assembly: new ObjectId().toHexString(),
58
- };
48
+ const body = flags['omit-features']
49
+ ? {
50
+ assemblyName,
51
+ fileIds: { fa: fileId },
52
+ typeName: 'AddAssemblyFromFileChange',
53
+ assembly: new ObjectId().toHexString(),
54
+ }
55
+ : {
56
+ assemblyName,
57
+ fileIds: { fa: fileId },
58
+ typeName: 'AddAssemblyAndFeaturesFromFileChange',
59
+ assembly: new ObjectId().toHexString(),
60
+ };
59
61
  const rec = await submitAssembly(access.address, access.accessToken, body, flags.force);
60
62
  this.log(JSON.stringify(rec, null, 2));
61
63
  }
@@ -47,8 +47,7 @@ export default class ApolloConfig extends BaseCommand {
47
47
  },
48
48
  ];
49
49
  async run() {
50
- const { args } = await this.parse(ApolloConfig);
51
- const { flags } = await this.parse(ApolloConfig);
50
+ const { args, flags } = await this.parse(ApolloConfig);
52
51
  let configFile = flags['config-file'];
53
52
  configFile =
54
53
  configFile === undefined
@@ -6,8 +6,10 @@ export default class Import extends FileCommand {
6
6
  description: string;
7
7
  command: string;
8
8
  }[];
9
+ static args: {
10
+ 'input-file': import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
11
+ };
9
12
  static flags: {
10
- 'input-file': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
11
13
  assembly: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
12
14
  'delete-existing': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
13
15
  };