@apollo-annotation/cli 0.2.1 → 0.3.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 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.2.1 linux-x64 node-v18.20.5
19
+ @apollo-annotation/cli/0.3.0 linux-x64 node-v18.20.5
20
20
  $ apollo --help [COMMAND]
21
21
  USAGE
22
22
  $ apollo COMMAND
@@ -108,7 +108,7 @@ EXAMPLES
108
108
  ```
109
109
 
110
110
  _See code:
111
- [src/commands/assembly/add-from-fasta.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/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.3.0/packages/apollo-cli/src/commands/assembly/add-from-fasta.ts)_
112
112
 
113
113
  ## `apollo assembly add-from-gff INPUT-FILE`
114
114
 
@@ -144,7 +144,7 @@ EXAMPLES
144
144
  ```
145
145
 
146
146
  _See code:
147
- [src/commands/assembly/add-from-gff.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/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.3.0/packages/apollo-cli/src/commands/assembly/add-from-gff.ts)_
148
148
 
149
149
  ## `apollo assembly check`
150
150
 
@@ -186,7 +186,7 @@ EXAMPLES
186
186
  ```
187
187
 
188
188
  _See code:
189
- [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/assembly/check.ts)_
189
+ [src/commands/assembly/check.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/assembly/check.ts)_
190
190
 
191
191
  ## `apollo assembly delete`
192
192
 
@@ -214,7 +214,7 @@ EXAMPLES
214
214
  ```
215
215
 
216
216
  _See code:
217
- [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/assembly/delete.ts)_
217
+ [src/commands/assembly/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/assembly/delete.ts)_
218
218
 
219
219
  ## `apollo assembly get`
220
220
 
@@ -236,7 +236,7 @@ DESCRIPTION
236
236
  ```
237
237
 
238
238
  _See code:
239
- [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/assembly/get.ts)_
239
+ [src/commands/assembly/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/assembly/get.ts)_
240
240
 
241
241
  ## `apollo assembly sequence`
242
242
 
@@ -271,7 +271,7 @@ EXAMPLES
271
271
  ```
272
272
 
273
273
  _See code:
274
- [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/assembly/sequence.ts)_
274
+ [src/commands/assembly/sequence.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/assembly/sequence.ts)_
275
275
 
276
276
  ## `apollo change get`
277
277
 
@@ -295,7 +295,7 @@ DESCRIPTION
295
295
  ```
296
296
 
297
297
  _See code:
298
- [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/change/get.ts)_
298
+ [src/commands/change/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/change/get.ts)_
299
299
 
300
300
  ## `apollo config [KEY] [VALUE]`
301
301
 
@@ -329,10 +329,7 @@ DESCRIPTION
329
329
  - accessToken:
330
330
  Access token. Usually inserted by `apollo login`
331
331
 
332
- - rootCredentials.username:
333
- Username of root account. Only set this for "root" access type
334
-
335
- - rootCredentials.password:
332
+ - rootPassword:
336
333
  Password for root account. Only set this for "root" access type
337
334
 
338
335
  EXAMPLES
@@ -350,7 +347,7 @@ EXAMPLES
350
347
  ```
351
348
 
352
349
  _See code:
353
- [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/config.ts)_
350
+ [src/commands/config.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/config.ts)_
354
351
 
355
352
  ## `apollo feature add-child`
356
353
 
@@ -381,7 +378,7 @@ EXAMPLES
381
378
  ```
382
379
 
383
380
  _See code:
384
- [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/add-child.ts)_
381
+ [src/commands/feature/add-child.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/add-child.ts)_
385
382
 
386
383
  ## `apollo feature check`
387
384
 
@@ -414,7 +411,7 @@ EXAMPLES
414
411
  ```
415
412
 
416
413
  _See code:
417
- [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/check.ts)_
414
+ [src/commands/feature/check.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/check.ts)_
418
415
 
419
416
  ## `apollo feature copy`
420
417
 
@@ -445,7 +442,7 @@ EXAMPLES
445
442
  ```
446
443
 
447
444
  _See code:
448
- [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/copy.ts)_
445
+ [src/commands/feature/copy.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/copy.ts)_
449
446
 
450
447
  ## `apollo feature delete`
451
448
 
@@ -469,7 +466,7 @@ DESCRIPTION
469
466
  ```
470
467
 
471
468
  _See code:
472
- [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/delete.ts)_
469
+ [src/commands/feature/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/delete.ts)_
473
470
 
474
471
  ## `apollo feature edit`
475
472
 
@@ -511,7 +508,7 @@ EXAMPLES
511
508
  ```
512
509
 
513
510
  _See code:
514
- [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/edit.ts)_
511
+ [src/commands/feature/edit.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/edit.ts)_
515
512
 
516
513
  ## `apollo feature edit-attribute`
517
514
 
@@ -551,7 +548,7 @@ EXAMPLES
551
548
  ```
552
549
 
553
550
  _See code:
554
- [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
551
+ [src/commands/feature/edit-attribute.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/edit-attribute.ts)_
555
552
 
556
553
  ## `apollo feature edit-coords`
557
554
 
@@ -585,7 +582,7 @@ EXAMPLES
585
582
  ```
586
583
 
587
584
  _See code:
588
- [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
585
+ [src/commands/feature/edit-coords.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/edit-coords.ts)_
589
586
 
590
587
  ## `apollo feature edit-type`
591
588
 
@@ -609,7 +606,7 @@ DESCRIPTION
609
606
  ```
610
607
 
611
608
  _See code:
612
- [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/edit-type.ts)_
609
+ [src/commands/feature/edit-type.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/edit-type.ts)_
613
610
 
614
611
  ## `apollo feature get`
615
612
 
@@ -643,7 +640,7 @@ EXAMPLES
643
640
  ```
644
641
 
645
642
  _See code:
646
- [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/get.ts)_
643
+ [src/commands/feature/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/get.ts)_
647
644
 
648
645
  ## `apollo feature get-id`
649
646
 
@@ -671,7 +668,7 @@ EXAMPLES
671
668
  ```
672
669
 
673
670
  _See code:
674
- [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/get-id.ts)_
671
+ [src/commands/feature/get-id.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/get-id.ts)_
675
672
 
676
673
  ## `apollo feature import INPUT-FILE`
677
674
 
@@ -702,7 +699,7 @@ EXAMPLES
702
699
  ```
703
700
 
704
701
  _See code:
705
- [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/import.ts)_
702
+ [src/commands/feature/import.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/import.ts)_
706
703
 
707
704
  ## `apollo feature search`
708
705
 
@@ -753,7 +750,7 @@ EXAMPLES
753
750
  ```
754
751
 
755
752
  _See code:
756
- [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/feature/search.ts)_
753
+ [src/commands/feature/search.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/feature/search.ts)_
757
754
 
758
755
  ## `apollo file delete`
759
756
 
@@ -780,7 +777,7 @@ EXAMPLES
780
777
  ```
781
778
 
782
779
  _See code:
783
- [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/file/delete.ts)_
780
+ [src/commands/file/delete.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/file/delete.ts)_
784
781
 
785
782
  ## `apollo file download`
786
783
 
@@ -808,7 +805,7 @@ EXAMPLES
808
805
  ```
809
806
 
810
807
  _See code:
811
- [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/file/download.ts)_
808
+ [src/commands/file/download.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/file/download.ts)_
812
809
 
813
810
  ## `apollo file get`
814
811
 
@@ -835,7 +832,7 @@ EXAMPLES
835
832
  ```
836
833
 
837
834
  _See code:
838
- [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/file/get.ts)_
835
+ [src/commands/file/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/file/get.ts)_
839
836
 
840
837
  ## `apollo file upload INPUT-FILE`
841
838
 
@@ -872,7 +869,7 @@ EXAMPLES
872
869
  ```
873
870
 
874
871
  _See code:
875
- [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/file/upload.ts)_
872
+ [src/commands/file/upload.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/file/upload.ts)_
876
873
 
877
874
  ## `apollo help [COMMANDS]`
878
875
 
@@ -919,7 +916,7 @@ EXAMPLES
919
916
  ```
920
917
 
921
918
  _See code:
922
- [src/commands/jbrowse/get-config.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/jbrowse/get-config.ts)_
919
+ [src/commands/jbrowse/get-config.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/jbrowse/get-config.ts)_
923
920
 
924
921
  ## `apollo jbrowse set-config INPUTFILE`
925
922
 
@@ -948,7 +945,7 @@ EXAMPLES
948
945
  ```
949
946
 
950
947
  _See code:
951
- [src/commands/jbrowse/set-config.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/jbrowse/set-config.ts)_
948
+ [src/commands/jbrowse/set-config.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/jbrowse/set-config.ts)_
952
949
 
953
950
  ## `apollo login`
954
951
 
@@ -987,7 +984,7 @@ EXAMPLES
987
984
  ```
988
985
 
989
986
  _See code:
990
- [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/login.ts)_
987
+ [src/commands/login.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/login.ts)_
991
988
 
992
989
  ## `apollo logout`
993
990
 
@@ -1017,7 +1014,7 @@ EXAMPLES
1017
1014
  ```
1018
1015
 
1019
1016
  _See code:
1020
- [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/logout.ts)_
1017
+ [src/commands/logout.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/logout.ts)_
1021
1018
 
1022
1019
  ## `apollo refseq add-alias INPUT-FILE`
1023
1020
 
@@ -1048,7 +1045,7 @@ EXAMPLES
1048
1045
  ```
1049
1046
 
1050
1047
  _See code:
1051
- [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
1048
+ [src/commands/refseq/add-alias.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/refseq/add-alias.ts)_
1052
1049
 
1053
1050
  ## `apollo refseq get`
1054
1051
 
@@ -1080,7 +1077,7 @@ EXAMPLES
1080
1077
  ```
1081
1078
 
1082
1079
  _See code:
1083
- [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/refseq/get.ts)_
1080
+ [src/commands/refseq/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/refseq/get.ts)_
1084
1081
 
1085
1082
  ## `apollo status`
1086
1083
 
@@ -1102,7 +1099,7 @@ DESCRIPTION
1102
1099
  ```
1103
1100
 
1104
1101
  _See code:
1105
- [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/status.ts)_
1102
+ [src/commands/status.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/status.ts)_
1106
1103
 
1107
1104
  ## `apollo user get`
1108
1105
 
@@ -1138,6 +1135,6 @@ EXAMPLES
1138
1135
  ```
1139
1136
 
1140
1137
  _See code:
1141
- [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.2.1/packages/apollo-cli/src/commands/user/get.ts)_
1138
+ [src/commands/user/get.ts](https://github.com/GMOD/Apollo3/blob/v0.3.0/packages/apollo-cli/src/commands/user/get.ts)_
1142
1139
 
1143
1140
  <!-- commandsstop -->
@@ -5,8 +5,7 @@ export declare enum KEYS {
5
5
  address = "address",
6
6
  accessType = "accessType",
7
7
  accessToken = "accessToken",
8
- rootCredentials_username = "rootCredentials.username",
9
- rootCredentials_password = "rootCredentials.password"
8
+ rootPassword = "rootPassword"
10
9
  }
11
10
  export declare function optionDesc(): string[];
12
11
  export declare class ApolloConf extends Conf {
@@ -12,8 +12,7 @@ export var KEYS;
12
12
  KEYS["address"] = "address";
13
13
  KEYS["accessType"] = "accessType";
14
14
  KEYS["accessToken"] = "accessToken";
15
- KEYS["rootCredentials_username"] = "rootCredentials.username";
16
- KEYS["rootCredentials_password"] = "rootCredentials.password";
15
+ KEYS["rootPassword"] = "rootPassword";
17
16
  })(KEYS || (KEYS = {}));
18
17
  function optionDocs() {
19
18
  const docs = [];
@@ -40,14 +39,7 @@ function optionDocs() {
40
39
  });
41
40
  break;
42
41
  }
43
- case 'rootCredentials.username': {
44
- docs.push({
45
- key: v,
46
- description: 'Username of root account. Only set this for "root" access type',
47
- });
48
- break;
49
- }
50
- case 'rootCredentials.password': {
42
+ case 'rootPassword': {
51
43
  docs.push({
52
44
  key: v,
53
45
  description: 'Password for root account. Only set this for "root" access type',
@@ -111,7 +103,7 @@ export class ApolloConf extends Conf {
111
103
  }
112
104
  setAccessType(profileName, accessType) {
113
105
  if (accessType != 'root') {
114
- this.delete(`${profileName}.rootCredentials`);
106
+ this.delete(`${profileName}.rootPassword`);
115
107
  }
116
108
  this.set(`${profileName}.accessType`, accessType);
117
109
  }
@@ -133,10 +125,7 @@ const profileSchema = Joi.object({
133
125
  address: Joi.string().uri({ scheme: /https?/ }),
134
126
  accessType: Joi.string().valid('google', 'microsoft', 'root', 'guest'),
135
127
  accessToken: Joi.string(),
136
- rootCredentials: Joi.object({
137
- username: Joi.string(),
138
- password: Joi.string(),
139
- }).when('accessType', {
128
+ rootPassword: Joi.string().when('accessType', {
140
129
  is: Joi.string().valid('root'),
141
130
  otherwise: Joi.forbidden(),
142
131
  }),
@@ -97,10 +97,8 @@ export default class ApolloConfig extends BaseCommand {
97
97
  accessType = await this.selectAccessType(address);
98
98
  config.setAccessType(profileName, accessType);
99
99
  if (accessType === 'root') {
100
- const username = await this.askUsername(config.get(`${profileName}.${KEYS.rootCredentials_username}`));
101
- config.set(`${profileName}.rootCredentials.username`, username);
102
100
  const password = await this.askPassword();
103
- config.set(`${profileName}.rootCredentials.password`, password);
101
+ config.set(`${profileName}.rootPassword`, password);
104
102
  }
105
103
  }
106
104
  async askProfileName(currentProfiles) {
@@ -74,14 +74,12 @@ need to execute this command again unless the token has expired. To setup a new
74
74
  await this.checkUserAlreadyLoggedIn(config, profileName);
75
75
  }
76
76
  if (accessType === 'root' || flags.username !== undefined) {
77
- const username = flags.username ??
78
- config.get(`${profileName}.rootCredentials.username`);
79
77
  const password = flags.password ??
80
- config.get(`${profileName}.rootCredentials.password`);
81
- if (username === undefined || password === undefined) {
78
+ config.get(`${profileName}.rootPassword`);
79
+ if (password === undefined) {
82
80
  this.error('Username and password must be set');
83
81
  }
84
- userCredentials = await this.startRootLogin(address, username, password);
82
+ userCredentials = await this.startRootLogin(address, password);
85
83
  }
86
84
  else if (accessType === 'guest') {
87
85
  userCredentials = await this.startGuestLogin(address);
@@ -114,12 +112,12 @@ need to execute this command again unless the token has expired. To setup a new
114
112
  this.exit(0);
115
113
  }
116
114
  }
117
- async startRootLogin(address, username, password) {
115
+ async startRootLogin(address, password) {
118
116
  const url = localhostToAddress(`${address}/auth/root`);
119
117
  const response = await fetch(url, {
120
118
  headers: { 'Content-Type': 'application/json' },
121
119
  method: 'POST',
122
- body: JSON.stringify({ username, password }),
120
+ body: JSON.stringify({ password }),
123
121
  });
124
122
  if (!response.ok) {
125
123
  const errorMessage = await createFetchErrorMessage(response, 'startRootLogin failed');
@@ -12,7 +12,7 @@
12
12
  "name": "value"
13
13
  }
14
14
  },
15
- "description": "Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:\n\n - address:\nAddress and port e.g http://localhost:3999\n\n- accessType:\nHow to access Apollo. accessType is typically one of: google, microsoft, guest, root. Allowed types depend on your Apollo setup\n\n- accessToken:\nAccess token. Usually inserted by `apollo login`\n\n- rootCredentials.username:\nUsername of root account. Only set this for \"root\" access type\n\n- rootCredentials.password:\nPassword for root account. Only set this for \"root\" access type",
15
+ "description": "Use this command to create or edit a user profile with credentials to access Apollo. Configuration options are:\n\n - address:\nAddress and port e.g http://localhost:3999\n\n- accessType:\nHow to access Apollo. accessType is typically one of: google, microsoft, guest, root. Allowed types depend on your Apollo setup\n\n- accessToken:\nAccess token. Usually inserted by `apollo login`\n\n- rootPassword:\nPassword for root account. Only set this for \"root\" access type",
16
16
  "examples": [
17
17
  {
18
18
  "description": "Interactive setup:",
@@ -725,6 +725,254 @@
725
725
  "get.js"
726
726
  ]
727
727
  },
728
+ "file:delete": {
729
+ "aliases": [],
730
+ "args": {},
731
+ "description": "Deleted files are printed to stdout. See also `apollo file get` to list the files on the server",
732
+ "examples": [
733
+ {
734
+ "description": "Delete file multiple files:",
735
+ "command": "<%= config.bin %> <%= command.id %> -i 123...abc xyz...789"
736
+ }
737
+ ],
738
+ "flags": {
739
+ "profile": {
740
+ "description": "Use credentials from this profile",
741
+ "name": "profile",
742
+ "hasDynamicHelp": false,
743
+ "multiple": false,
744
+ "type": "option"
745
+ },
746
+ "config-file": {
747
+ "description": "Use this config file (mostly for testing)",
748
+ "name": "config-file",
749
+ "hasDynamicHelp": false,
750
+ "multiple": false,
751
+ "type": "option"
752
+ },
753
+ "file-id": {
754
+ "char": "i",
755
+ "description": "IDs of the files to delete",
756
+ "name": "file-id",
757
+ "default": [
758
+ "-"
759
+ ],
760
+ "hasDynamicHelp": false,
761
+ "multiple": true,
762
+ "type": "option"
763
+ }
764
+ },
765
+ "hasDynamicHelp": false,
766
+ "hiddenAliases": [],
767
+ "id": "file:delete",
768
+ "pluginAlias": "@apollo-annotation/cli",
769
+ "pluginName": "@apollo-annotation/cli",
770
+ "pluginType": "core",
771
+ "strict": true,
772
+ "summary": "Delete files from the Apollo server",
773
+ "enableJsonFlag": false,
774
+ "isESM": true,
775
+ "relativePath": [
776
+ "dist",
777
+ "commands",
778
+ "file",
779
+ "delete.js"
780
+ ]
781
+ },
782
+ "file:download": {
783
+ "aliases": [],
784
+ "args": {},
785
+ "description": "See also `apollo file get` to list the files on the server",
786
+ "examples": [
787
+ {
788
+ "description": "Download file with id xyz",
789
+ "command": "<%= config.bin %> <%= command.id %> -i xyz -o genome.fa"
790
+ }
791
+ ],
792
+ "flags": {
793
+ "profile": {
794
+ "description": "Use credentials from this profile",
795
+ "name": "profile",
796
+ "hasDynamicHelp": false,
797
+ "multiple": false,
798
+ "type": "option"
799
+ },
800
+ "config-file": {
801
+ "description": "Use this config file (mostly for testing)",
802
+ "name": "config-file",
803
+ "hasDynamicHelp": false,
804
+ "multiple": false,
805
+ "type": "option"
806
+ },
807
+ "file-id": {
808
+ "char": "i",
809
+ "description": "ID of the file to download",
810
+ "name": "file-id",
811
+ "default": "-",
812
+ "hasDynamicHelp": false,
813
+ "multiple": false,
814
+ "type": "option"
815
+ },
816
+ "output": {
817
+ "char": "o",
818
+ "description": "Write output to this file or \"-\" for stdout. Default to the name of the uploaded file.",
819
+ "name": "output",
820
+ "hasDynamicHelp": false,
821
+ "multiple": false,
822
+ "type": "option"
823
+ }
824
+ },
825
+ "hasDynamicHelp": false,
826
+ "hiddenAliases": [],
827
+ "id": "file:download",
828
+ "pluginAlias": "@apollo-annotation/cli",
829
+ "pluginName": "@apollo-annotation/cli",
830
+ "pluginType": "core",
831
+ "strict": true,
832
+ "summary": "Download a file from the Apollo server",
833
+ "enableJsonFlag": false,
834
+ "isESM": true,
835
+ "relativePath": [
836
+ "dist",
837
+ "commands",
838
+ "file",
839
+ "download.js"
840
+ ]
841
+ },
842
+ "file:get": {
843
+ "aliases": [],
844
+ "args": {},
845
+ "description": "Print to stdout the list of files in json format",
846
+ "examples": [
847
+ {
848
+ "description": "Get files by id:",
849
+ "command": "<%= config.bin %> <%= command.id %> -i xyz abc"
850
+ }
851
+ ],
852
+ "flags": {
853
+ "profile": {
854
+ "description": "Use credentials from this profile",
855
+ "name": "profile",
856
+ "hasDynamicHelp": false,
857
+ "multiple": false,
858
+ "type": "option"
859
+ },
860
+ "config-file": {
861
+ "description": "Use this config file (mostly for testing)",
862
+ "name": "config-file",
863
+ "hasDynamicHelp": false,
864
+ "multiple": false,
865
+ "type": "option"
866
+ },
867
+ "file-id": {
868
+ "char": "i",
869
+ "description": "Get files matching this IDs",
870
+ "name": "file-id",
871
+ "hasDynamicHelp": false,
872
+ "multiple": true,
873
+ "type": "option"
874
+ }
875
+ },
876
+ "hasDynamicHelp": false,
877
+ "hiddenAliases": [],
878
+ "id": "file:get",
879
+ "pluginAlias": "@apollo-annotation/cli",
880
+ "pluginName": "@apollo-annotation/cli",
881
+ "pluginType": "core",
882
+ "strict": true,
883
+ "summary": "Get list of files uploaded to the Apollo server",
884
+ "enableJsonFlag": false,
885
+ "isESM": true,
886
+ "relativePath": [
887
+ "dist",
888
+ "commands",
889
+ "file",
890
+ "get.js"
891
+ ]
892
+ },
893
+ "file:upload": {
894
+ "aliases": [],
895
+ "args": {
896
+ "input-file": {
897
+ "description": "Local file to upload",
898
+ "name": "input-file",
899
+ "required": true
900
+ }
901
+ },
902
+ "description": "This command only uploads a file and returns the corresponding file id.\n To add an assembly based on this file or to upload & add an assembly in a single pass see `apollo assembly add-from-fasta` and `add-from-gff`",
903
+ "examples": [
904
+ {
905
+ "description": "Upload local file, type auto-detected:",
906
+ "command": "<%= config.bin %> <%= command.id %> genome.fa > file.json"
907
+ }
908
+ ],
909
+ "flags": {
910
+ "profile": {
911
+ "description": "Use credentials from this profile",
912
+ "name": "profile",
913
+ "hasDynamicHelp": false,
914
+ "multiple": false,
915
+ "type": "option"
916
+ },
917
+ "config-file": {
918
+ "description": "Use this config file (mostly for testing)",
919
+ "name": "config-file",
920
+ "hasDynamicHelp": false,
921
+ "multiple": false,
922
+ "type": "option"
923
+ },
924
+ "type": {
925
+ "char": "t",
926
+ "description": "Set file type or autodetected it if not set.\n NB: There is no check for whether the file complies to this type",
927
+ "name": "type",
928
+ "hasDynamicHelp": false,
929
+ "multiple": false,
930
+ "options": [
931
+ "text/x-fasta",
932
+ "text/x-gff3",
933
+ "application/x-bgzip-fasta",
934
+ "text/x-fai",
935
+ "application/x-gzi"
936
+ ],
937
+ "type": "option"
938
+ },
939
+ "gzip": {
940
+ "char": "z",
941
+ "description": "Override autodetection and instruct that input is gzip compressed",
942
+ "exclusive": [
943
+ "decompressed"
944
+ ],
945
+ "name": "gzip",
946
+ "allowNo": false,
947
+ "type": "boolean"
948
+ },
949
+ "decompressed": {
950
+ "char": "d",
951
+ "description": "Override autodetection and instruct that input is decompressed",
952
+ "exclusive": [
953
+ "gzip"
954
+ ],
955
+ "name": "decompressed",
956
+ "allowNo": false,
957
+ "type": "boolean"
958
+ }
959
+ },
960
+ "hasDynamicHelp": false,
961
+ "hiddenAliases": [],
962
+ "id": "file:upload",
963
+ "pluginAlias": "@apollo-annotation/cli",
964
+ "pluginName": "@apollo-annotation/cli",
965
+ "pluginType": "core",
966
+ "strict": true,
967
+ "summary": "Upload a local file to the Apollo server",
968
+ "isESM": true,
969
+ "relativePath": [
970
+ "dist",
971
+ "commands",
972
+ "file",
973
+ "upload.js"
974
+ ]
975
+ },
728
976
  "feature:add-child": {
729
977
  "aliases": [],
730
978
  "args": {},
@@ -1527,254 +1775,6 @@
1527
1775
  "search.js"
1528
1776
  ]
1529
1777
  },
1530
- "file:delete": {
1531
- "aliases": [],
1532
- "args": {},
1533
- "description": "Deleted files are printed to stdout. See also `apollo file get` to list the files on the server",
1534
- "examples": [
1535
- {
1536
- "description": "Delete file multiple files:",
1537
- "command": "<%= config.bin %> <%= command.id %> -i 123...abc xyz...789"
1538
- }
1539
- ],
1540
- "flags": {
1541
- "profile": {
1542
- "description": "Use credentials from this profile",
1543
- "name": "profile",
1544
- "hasDynamicHelp": false,
1545
- "multiple": false,
1546
- "type": "option"
1547
- },
1548
- "config-file": {
1549
- "description": "Use this config file (mostly for testing)",
1550
- "name": "config-file",
1551
- "hasDynamicHelp": false,
1552
- "multiple": false,
1553
- "type": "option"
1554
- },
1555
- "file-id": {
1556
- "char": "i",
1557
- "description": "IDs of the files to delete",
1558
- "name": "file-id",
1559
- "default": [
1560
- "-"
1561
- ],
1562
- "hasDynamicHelp": false,
1563
- "multiple": true,
1564
- "type": "option"
1565
- }
1566
- },
1567
- "hasDynamicHelp": false,
1568
- "hiddenAliases": [],
1569
- "id": "file:delete",
1570
- "pluginAlias": "@apollo-annotation/cli",
1571
- "pluginName": "@apollo-annotation/cli",
1572
- "pluginType": "core",
1573
- "strict": true,
1574
- "summary": "Delete files from the Apollo server",
1575
- "enableJsonFlag": false,
1576
- "isESM": true,
1577
- "relativePath": [
1578
- "dist",
1579
- "commands",
1580
- "file",
1581
- "delete.js"
1582
- ]
1583
- },
1584
- "file:download": {
1585
- "aliases": [],
1586
- "args": {},
1587
- "description": "See also `apollo file get` to list the files on the server",
1588
- "examples": [
1589
- {
1590
- "description": "Download file with id xyz",
1591
- "command": "<%= config.bin %> <%= command.id %> -i xyz -o genome.fa"
1592
- }
1593
- ],
1594
- "flags": {
1595
- "profile": {
1596
- "description": "Use credentials from this profile",
1597
- "name": "profile",
1598
- "hasDynamicHelp": false,
1599
- "multiple": false,
1600
- "type": "option"
1601
- },
1602
- "config-file": {
1603
- "description": "Use this config file (mostly for testing)",
1604
- "name": "config-file",
1605
- "hasDynamicHelp": false,
1606
- "multiple": false,
1607
- "type": "option"
1608
- },
1609
- "file-id": {
1610
- "char": "i",
1611
- "description": "ID of the file to download",
1612
- "name": "file-id",
1613
- "default": "-",
1614
- "hasDynamicHelp": false,
1615
- "multiple": false,
1616
- "type": "option"
1617
- },
1618
- "output": {
1619
- "char": "o",
1620
- "description": "Write output to this file or \"-\" for stdout. Default to the name of the uploaded file.",
1621
- "name": "output",
1622
- "hasDynamicHelp": false,
1623
- "multiple": false,
1624
- "type": "option"
1625
- }
1626
- },
1627
- "hasDynamicHelp": false,
1628
- "hiddenAliases": [],
1629
- "id": "file:download",
1630
- "pluginAlias": "@apollo-annotation/cli",
1631
- "pluginName": "@apollo-annotation/cli",
1632
- "pluginType": "core",
1633
- "strict": true,
1634
- "summary": "Download a file from the Apollo server",
1635
- "enableJsonFlag": false,
1636
- "isESM": true,
1637
- "relativePath": [
1638
- "dist",
1639
- "commands",
1640
- "file",
1641
- "download.js"
1642
- ]
1643
- },
1644
- "file:get": {
1645
- "aliases": [],
1646
- "args": {},
1647
- "description": "Print to stdout the list of files in json format",
1648
- "examples": [
1649
- {
1650
- "description": "Get files by id:",
1651
- "command": "<%= config.bin %> <%= command.id %> -i xyz abc"
1652
- }
1653
- ],
1654
- "flags": {
1655
- "profile": {
1656
- "description": "Use credentials from this profile",
1657
- "name": "profile",
1658
- "hasDynamicHelp": false,
1659
- "multiple": false,
1660
- "type": "option"
1661
- },
1662
- "config-file": {
1663
- "description": "Use this config file (mostly for testing)",
1664
- "name": "config-file",
1665
- "hasDynamicHelp": false,
1666
- "multiple": false,
1667
- "type": "option"
1668
- },
1669
- "file-id": {
1670
- "char": "i",
1671
- "description": "Get files matching this IDs",
1672
- "name": "file-id",
1673
- "hasDynamicHelp": false,
1674
- "multiple": true,
1675
- "type": "option"
1676
- }
1677
- },
1678
- "hasDynamicHelp": false,
1679
- "hiddenAliases": [],
1680
- "id": "file:get",
1681
- "pluginAlias": "@apollo-annotation/cli",
1682
- "pluginName": "@apollo-annotation/cli",
1683
- "pluginType": "core",
1684
- "strict": true,
1685
- "summary": "Get list of files uploaded to the Apollo server",
1686
- "enableJsonFlag": false,
1687
- "isESM": true,
1688
- "relativePath": [
1689
- "dist",
1690
- "commands",
1691
- "file",
1692
- "get.js"
1693
- ]
1694
- },
1695
- "file:upload": {
1696
- "aliases": [],
1697
- "args": {
1698
- "input-file": {
1699
- "description": "Local file to upload",
1700
- "name": "input-file",
1701
- "required": true
1702
- }
1703
- },
1704
- "description": "This command only uploads a file and returns the corresponding file id.\n To add an assembly based on this file or to upload & add an assembly in a single pass see `apollo assembly add-from-fasta` and `add-from-gff`",
1705
- "examples": [
1706
- {
1707
- "description": "Upload local file, type auto-detected:",
1708
- "command": "<%= config.bin %> <%= command.id %> genome.fa > file.json"
1709
- }
1710
- ],
1711
- "flags": {
1712
- "profile": {
1713
- "description": "Use credentials from this profile",
1714
- "name": "profile",
1715
- "hasDynamicHelp": false,
1716
- "multiple": false,
1717
- "type": "option"
1718
- },
1719
- "config-file": {
1720
- "description": "Use this config file (mostly for testing)",
1721
- "name": "config-file",
1722
- "hasDynamicHelp": false,
1723
- "multiple": false,
1724
- "type": "option"
1725
- },
1726
- "type": {
1727
- "char": "t",
1728
- "description": "Set file type or autodetected it if not set.\n NB: There is no check for whether the file complies to this type",
1729
- "name": "type",
1730
- "hasDynamicHelp": false,
1731
- "multiple": false,
1732
- "options": [
1733
- "text/x-fasta",
1734
- "text/x-gff3",
1735
- "application/x-bgzip-fasta",
1736
- "text/x-fai",
1737
- "application/x-gzi"
1738
- ],
1739
- "type": "option"
1740
- },
1741
- "gzip": {
1742
- "char": "z",
1743
- "description": "Override autodetection and instruct that input is gzip compressed",
1744
- "exclusive": [
1745
- "decompressed"
1746
- ],
1747
- "name": "gzip",
1748
- "allowNo": false,
1749
- "type": "boolean"
1750
- },
1751
- "decompressed": {
1752
- "char": "d",
1753
- "description": "Override autodetection and instruct that input is decompressed",
1754
- "exclusive": [
1755
- "gzip"
1756
- ],
1757
- "name": "decompressed",
1758
- "allowNo": false,
1759
- "type": "boolean"
1760
- }
1761
- },
1762
- "hasDynamicHelp": false,
1763
- "hiddenAliases": [],
1764
- "id": "file:upload",
1765
- "pluginAlias": "@apollo-annotation/cli",
1766
- "pluginName": "@apollo-annotation/cli",
1767
- "pluginType": "core",
1768
- "strict": true,
1769
- "summary": "Upload a local file to the Apollo server",
1770
- "isESM": true,
1771
- "relativePath": [
1772
- "dist",
1773
- "commands",
1774
- "file",
1775
- "upload.js"
1776
- ]
1777
- },
1778
1778
  "jbrowse:get-config": {
1779
1779
  "aliases": [],
1780
1780
  "args": {},
@@ -2048,5 +2048,5 @@
2048
2048
  ]
2049
2049
  }
2050
2050
  },
2051
- "version": "0.2.1"
2051
+ "version": "0.3.0"
2052
2052
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apollo-annotation/cli",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Command line interface for the Apollo annotation server",
5
5
  "repository": {
6
6
  "type": "git",
@@ -29,7 +29,7 @@
29
29
  "test": "mocha --require src/test/fixtures.ts 'src/**/*.test.ts'",
30
30
  "posttest": "yarn lint",
31
31
  "test:ci": "nyc mocha 'src/**/*.test.ts'",
32
- "version": "oclif readme --multi --dir ../website/docs/cli/ && oclif readme && git add README.md"
32
+ "version": "oclif readme --multi --dir ../website/docs/admin/cli/ && oclif readme && git add README.md"
33
33
  },
34
34
  "oclif": {
35
35
  "bin": "apollo",
@@ -84,8 +84,8 @@
84
84
  "yaml": "^2.3.4"
85
85
  },
86
86
  "devDependencies": {
87
- "@apollo-annotation/mst": "^0.2.1",
88
- "@apollo-annotation/shared": "^0.2.1",
87
+ "@apollo-annotation/mst": "^0.3.0",
88
+ "@apollo-annotation/shared": "^0.3.0",
89
89
  "@istanbuljs/esm-loader-hook": "^0.2.0",
90
90
  "@istanbuljs/nyc-config-typescript": "^1.0.2",
91
91
  "@oclif/test": "^3.1.3",