UNPKG

23.9 kBJSONView Raw
1{
2 "version": "0.54.0-alpha-20230724180700-d5ce4e2",
3 "commands": {
4 "add": {
5 "id": "add",
6 "description": "Adds a new datasource to a subgraph.",
7 "strict": true,
8 "pluginName": "@graphprotocol/graph-cli",
9 "pluginAlias": "@graphprotocol/graph-cli",
10 "pluginType": "core",
11 "aliases": [],
12 "flags": {
13 "help": {
14 "name": "help",
15 "type": "boolean",
16 "char": "h",
17 "description": "Show CLI help.",
18 "allowNo": false
19 },
20 "abi": {
21 "name": "abi",
22 "type": "option",
23 "summary": "Path to the contract ABI.",
24 "multiple": false
25 },
26 "start-block": {
27 "name": "start-block",
28 "type": "option",
29 "summary": "The block number to start indexing events from.",
30 "multiple": false
31 },
32 "contract-name": {
33 "name": "contract-name",
34 "type": "option",
35 "summary": "Name of the contract.",
36 "multiple": false,
37 "default": "Contract"
38 },
39 "merge-entities": {
40 "name": "merge-entities",
41 "type": "boolean",
42 "summary": "Whether to merge entities with the same name.",
43 "allowNo": false
44 },
45 "network-file": {
46 "name": "network-file",
47 "type": "option",
48 "summary": "Networks config file path.",
49 "multiple": false,
50 "default": "networks.json"
51 }
52 },
53 "args": {
54 "address": {
55 "name": "address",
56 "description": "The contract address",
57 "required": true
58 },
59 "subgraph-manifest": {
60 "name": "subgraph-manifest",
61 "default": "subgraph.yaml"
62 }
63 }
64 },
65 "auth": {
66 "id": "auth",
67 "description": "Sets the deploy key to use when deploying to a Graph node.",
68 "strict": true,
69 "pluginName": "@graphprotocol/graph-cli",
70 "pluginAlias": "@graphprotocol/graph-cli",
71 "pluginType": "core",
72 "aliases": [],
73 "flags": {
74 "help": {
75 "name": "help",
76 "type": "boolean",
77 "char": "h",
78 "description": "Show CLI help.",
79 "allowNo": false
80 },
81 "product": {
82 "name": "product",
83 "type": "option",
84 "summary": "Select a product for which to authenticate.",
85 "multiple": false,
86 "options": [
87 "subgraph-studio",
88 "hosted-service"
89 ]
90 },
91 "studio": {
92 "name": "studio",
93 "type": "boolean",
94 "summary": "Shortcut for \"--product subgraph-studio\".",
95 "allowNo": false,
96 "exclusive": [
97 "product"
98 ]
99 }
100 },
101 "args": {
102 "node": {
103 "name": "node"
104 },
105 "deploy-key": {
106 "name": "deploy-key"
107 }
108 }
109 },
110 "build": {
111 "id": "build",
112 "description": "Builds a subgraph and (optionally) uploads it to IPFS.",
113 "strict": true,
114 "pluginName": "@graphprotocol/graph-cli",
115 "pluginAlias": "@graphprotocol/graph-cli",
116 "pluginType": "core",
117 "aliases": [],
118 "flags": {
119 "help": {
120 "name": "help",
121 "type": "boolean",
122 "char": "h",
123 "description": "Show CLI help.",
124 "allowNo": false
125 },
126 "ipfs": {
127 "name": "ipfs",
128 "type": "option",
129 "char": "i",
130 "summary": "Upload build results to an IPFS node.",
131 "multiple": false
132 },
133 "output-dir": {
134 "name": "output-dir",
135 "type": "option",
136 "char": "o",
137 "summary": "Output directory for build results.",
138 "multiple": false,
139 "default": "build/"
140 },
141 "output-format": {
142 "name": "output-format",
143 "type": "option",
144 "char": "t",
145 "summary": "Output format for mappings.",
146 "multiple": false,
147 "options": [
148 "wasm",
149 "wast"
150 ],
151 "default": "wasm"
152 },
153 "skip-migrations": {
154 "name": "skip-migrations",
155 "type": "boolean",
156 "summary": "Skip subgraph migrations.",
157 "allowNo": false
158 },
159 "watch": {
160 "name": "watch",
161 "type": "boolean",
162 "char": "w",
163 "summary": "Regenerate types when subgraph files change.",
164 "allowNo": false
165 },
166 "network": {
167 "name": "network",
168 "type": "option",
169 "summary": "Network configuration to use from the networks config file.",
170 "multiple": false
171 },
172 "network-file": {
173 "name": "network-file",
174 "type": "option",
175 "summary": "Networks config file path.",
176 "multiple": false,
177 "default": "networks.json"
178 }
179 },
180 "args": {
181 "subgraph-manifest": {
182 "name": "subgraph-manifest",
183 "default": "subgraph.yaml"
184 }
185 }
186 },
187 "clean": {
188 "id": "clean",
189 "description": "Clean the cache and generated files.",
190 "strict": true,
191 "pluginName": "@graphprotocol/graph-cli",
192 "pluginAlias": "@graphprotocol/graph-cli",
193 "pluginType": "core",
194 "aliases": [],
195 "flags": {
196 "help": {
197 "name": "help",
198 "type": "boolean",
199 "char": "h",
200 "description": "Show CLI help.",
201 "allowNo": false
202 },
203 "codegen-dir": {
204 "name": "codegen-dir",
205 "type": "option",
206 "summary": "Directory where the \"graph codegen\" code is stored.",
207 "multiple": false,
208 "default": "generated/"
209 },
210 "build-dir": {
211 "name": "build-dir",
212 "type": "option",
213 "summary": "Directory where the \"graph build\" code is stored.",
214 "multiple": false,
215 "default": "build/"
216 }
217 },
218 "args": {}
219 },
220 "codegen": {
221 "id": "codegen",
222 "description": "Generates AssemblyScript types for a subgraph.",
223 "strict": true,
224 "pluginName": "@graphprotocol/graph-cli",
225 "pluginAlias": "@graphprotocol/graph-cli",
226 "pluginType": "core",
227 "aliases": [],
228 "flags": {
229 "help": {
230 "name": "help",
231 "type": "boolean",
232 "char": "h",
233 "description": "Show CLI help.",
234 "allowNo": false
235 },
236 "output-dir": {
237 "name": "output-dir",
238 "type": "option",
239 "char": "o",
240 "summary": "Output directory for generated types.",
241 "multiple": false,
242 "default": "generated/"
243 },
244 "skip-migrations": {
245 "name": "skip-migrations",
246 "type": "boolean",
247 "summary": "Skip subgraph migrations.",
248 "allowNo": false
249 },
250 "watch": {
251 "name": "watch",
252 "type": "boolean",
253 "char": "w",
254 "summary": "Regenerate types when subgraph files change.",
255 "allowNo": false
256 },
257 "uncrashable": {
258 "name": "uncrashable",
259 "type": "boolean",
260 "char": "u",
261 "summary": "Generate Float Subgraph Uncrashable helper file.",
262 "allowNo": false
263 },
264 "uncrashable-config": {
265 "name": "uncrashable-config",
266 "type": "option",
267 "summary": "Directory for uncrashable config.",
268 "multiple": false,
269 "dependsOn": [
270 "uncrashable"
271 ],
272 "aliases": [
273 "uc"
274 ]
275 }
276 },
277 "args": {
278 "subgraph-manifest": {
279 "name": "subgraph-manifest",
280 "default": "subgraph.yaml"
281 }
282 }
283 },
284 "create": {
285 "id": "create",
286 "description": "Registers a subgraph name",
287 "strict": true,
288 "pluginName": "@graphprotocol/graph-cli",
289 "pluginAlias": "@graphprotocol/graph-cli",
290 "pluginType": "core",
291 "aliases": [],
292 "flags": {
293 "help": {
294 "name": "help",
295 "type": "boolean",
296 "char": "h",
297 "description": "Show CLI help.",
298 "allowNo": false
299 },
300 "node": {
301 "name": "node",
302 "type": "option",
303 "char": "g",
304 "summary": "Graph node to create the subgraph in.",
305 "required": true,
306 "multiple": false
307 },
308 "access-token": {
309 "name": "access-token",
310 "type": "option",
311 "summary": "Graph access token.",
312 "multiple": false
313 }
314 },
315 "args": {
316 "subgraph-name": {
317 "name": "subgraph-name",
318 "required": true
319 }
320 }
321 },
322 "deploy": {
323 "id": "deploy",
324 "description": "Deploys a subgraph to a Graph node.",
325 "strict": true,
326 "pluginName": "@graphprotocol/graph-cli",
327 "pluginAlias": "@graphprotocol/graph-cli",
328 "pluginType": "core",
329 "aliases": [],
330 "flags": {
331 "help": {
332 "name": "help",
333 "type": "boolean",
334 "char": "h",
335 "description": "Show CLI help.",
336 "allowNo": false
337 },
338 "product": {
339 "name": "product",
340 "type": "option",
341 "summary": "Select a product for which to authenticate.",
342 "multiple": false,
343 "options": [
344 "subgraph-studio",
345 "hosted-service"
346 ]
347 },
348 "studio": {
349 "name": "studio",
350 "type": "boolean",
351 "summary": "Shortcut for \"--product subgraph-studio\".",
352 "allowNo": false,
353 "exclusive": [
354 "product"
355 ]
356 },
357 "node": {
358 "name": "node",
359 "type": "option",
360 "char": "g",
361 "summary": "Graph node for which to initialize.",
362 "multiple": false
363 },
364 "deploy-key": {
365 "name": "deploy-key",
366 "type": "option",
367 "summary": "User deploy key.",
368 "multiple": false,
369 "exclusive": [
370 "access-token"
371 ]
372 },
373 "access-token": {
374 "name": "access-token",
375 "type": "option",
376 "summary": "Graph access key. DEPRECATED: Use \"--deploy-key\" instead.",
377 "multiple": false,
378 "exclusive": [
379 "deploy-key"
380 ],
381 "deprecated": true
382 },
383 "version-label": {
384 "name": "version-label",
385 "type": "option",
386 "char": "l",
387 "summary": "Version label used for the deployment.",
388 "multiple": false
389 },
390 "ipfs": {
391 "name": "ipfs",
392 "type": "option",
393 "char": "i",
394 "summary": "Upload build results to an IPFS node.",
395 "multiple": false,
396 "default": "https://api.thegraph.com/ipfs/api/v0"
397 },
398 "ipfs-hash": {
399 "name": "ipfs-hash",
400 "type": "option",
401 "summary": "IPFS hash of the subgraph manifest to deploy.",
402 "required": false,
403 "multiple": false
404 },
405 "headers": {
406 "name": "headers",
407 "type": "option",
408 "summary": "Add custom headers that will be used by the IPFS HTTP client.",
409 "multiple": false,
410 "default": {},
411 "aliases": [
412 "hdr"
413 ]
414 },
415 "debug-fork": {
416 "name": "debug-fork",
417 "type": "option",
418 "summary": "ID of a remote subgraph whose store will be GraphQL queried.",
419 "multiple": false
420 },
421 "output-dir": {
422 "name": "output-dir",
423 "type": "option",
424 "char": "o",
425 "summary": "Output directory for build results.",
426 "multiple": false,
427 "default": "build/"
428 },
429 "skip-migrations": {
430 "name": "skip-migrations",
431 "type": "boolean",
432 "summary": "Skip subgraph migrations.",
433 "allowNo": false
434 },
435 "watch": {
436 "name": "watch",
437 "type": "boolean",
438 "char": "w",
439 "summary": "Regenerate types when subgraph files change.",
440 "allowNo": false
441 },
442 "network": {
443 "name": "network",
444 "type": "option",
445 "summary": "Network configuration to use from the networks config file.",
446 "multiple": false
447 },
448 "network-file": {
449 "name": "network-file",
450 "type": "option",
451 "summary": "Networks config file path.",
452 "multiple": false,
453 "default": "networks.json"
454 }
455 },
456 "args": {
457 "subgraph-name": {
458 "name": "subgraph-name"
459 },
460 "subgraph-manifest": {
461 "name": "subgraph-manifest",
462 "default": "subgraph.yaml"
463 }
464 }
465 },
466 "init": {
467 "id": "init",
468 "description": "Creates a new subgraph with basic scaffolding.",
469 "strict": true,
470 "pluginName": "@graphprotocol/graph-cli",
471 "pluginAlias": "@graphprotocol/graph-cli",
472 "pluginType": "core",
473 "aliases": [],
474 "flags": {
475 "help": {
476 "name": "help",
477 "type": "boolean",
478 "char": "h",
479 "description": "Show CLI help.",
480 "allowNo": false
481 },
482 "protocol": {
483 "name": "protocol",
484 "type": "option",
485 "multiple": false,
486 "options": [
487 "arweave",
488 "ethereum",
489 "near",
490 "cosmos",
491 "substreams"
492 ]
493 },
494 "product": {
495 "name": "product",
496 "type": "option",
497 "summary": "Selects the product for which to initialize.",
498 "multiple": false,
499 "options": [
500 "subgraph-studio",
501 "hosted-service"
502 ]
503 },
504 "studio": {
505 "name": "studio",
506 "type": "boolean",
507 "summary": "Shortcut for \"--product subgraph-studio\".",
508 "allowNo": false,
509 "exclusive": [
510 "product"
511 ]
512 },
513 "node": {
514 "name": "node",
515 "type": "option",
516 "char": "g",
517 "summary": "Graph node for which to initialize.",
518 "multiple": false
519 },
520 "allow-simple-name": {
521 "name": "allow-simple-name",
522 "type": "boolean",
523 "description": "Use a subgraph name without a prefix.",
524 "allowNo": false
525 },
526 "from-contract": {
527 "name": "from-contract",
528 "type": "option",
529 "description": "Creates a scaffold based on an existing contract.",
530 "multiple": false,
531 "exclusive": [
532 "from-example"
533 ]
534 },
535 "from-example": {
536 "name": "from-example",
537 "type": "option",
538 "description": "Creates a scaffold based on an example subgraph.",
539 "multiple": false,
540 "exclusive": [
541 "from-contract"
542 ]
543 },
544 "contract-name": {
545 "name": "contract-name",
546 "type": "option",
547 "description": "Name of the contract.",
548 "helpGroup": "Scaffold from contract",
549 "multiple": false,
550 "dependsOn": [
551 "from-contract"
552 ]
553 },
554 "index-events": {
555 "name": "index-events",
556 "type": "boolean",
557 "description": "Index contract events as entities.",
558 "helpGroup": "Scaffold from contract",
559 "allowNo": false,
560 "dependsOn": [
561 "from-contract"
562 ]
563 },
564 "skip-install": {
565 "name": "skip-install",
566 "type": "boolean",
567 "summary": "Skip installing dependencies.",
568 "allowNo": false
569 },
570 "start-block": {
571 "name": "start-block",
572 "type": "option",
573 "description": "Block number to start indexing from.",
574 "helpGroup": "Scaffold from contract",
575 "multiple": false,
576 "dependsOn": [
577 "from-contract"
578 ]
579 },
580 "abi": {
581 "name": "abi",
582 "type": "option",
583 "summary": "Path to the contract ABI",
584 "multiple": false,
585 "dependsOn": [
586 "from-contract"
587 ]
588 },
589 "spkg": {
590 "name": "spkg",
591 "type": "option",
592 "summary": "Path to the SPKG file",
593 "multiple": false
594 },
595 "network": {
596 "name": "network",
597 "type": "option",
598 "summary": "Network the contract is deployed to.",
599 "multiple": false,
600 "options": [
601 "mainnet",
602 "rinkeby",
603 "goerli",
604 "poa-core",
605 "poa-sokol",
606 "gnosis",
607 "matic",
608 "mumbai",
609 "fantom",
610 "fantom-testnet",
611 "bsc",
612 "chapel",
613 "clover",
614 "avalanche",
615 "fuji",
616 "celo",
617 "celo-alfajores",
618 "fuse",
619 "moonbeam",
620 "moonriver",
621 "mbase",
622 "arbitrum-one",
623 "arbitrum-goerli",
624 "optimism",
625 "optimism-goerli",
626 "aurora",
627 "aurora-testnet",
628 "base-testnet",
629 "base",
630 "zksync-era",
631 "sepolia",
632 "polygon-zkevm-testnet",
633 "polygon-zkevm",
634 "near-mainnet",
635 "near-testnet",
636 "cosmoshub-4",
637 "theta-testnet-001",
638 "osmosis-1",
639 "osmo-test-4",
640 "juno-1",
641 "uni-3"
642 ],
643 "dependsOn": [
644 "from-contract"
645 ]
646 }
647 },
648 "args": {
649 "subgraphName": {
650 "name": "subgraphName"
651 },
652 "directory": {
653 "name": "directory"
654 }
655 }
656 },
657 "local": {
658 "id": "local",
659 "description": "Runs local tests against a Graph Node environment (using Ganache by default).",
660 "strict": true,
661 "pluginName": "@graphprotocol/graph-cli",
662 "pluginAlias": "@graphprotocol/graph-cli",
663 "pluginType": "core",
664 "aliases": [],
665 "flags": {
666 "help": {
667 "name": "help",
668 "type": "boolean",
669 "char": "h",
670 "description": "Show CLI help.",
671 "allowNo": false
672 },
673 "node-logs": {
674 "name": "node-logs",
675 "type": "boolean",
676 "summary": "Print the Graph Node logs.",
677 "allowNo": false
678 },
679 "ethereum-logs": {
680 "name": "ethereum-logs",
681 "type": "boolean",
682 "summary": "Print the Ethereum logs.",
683 "allowNo": false
684 },
685 "compose-file": {
686 "name": "compose-file",
687 "type": "option",
688 "summary": "Custom Docker Compose file for additional services.",
689 "multiple": false
690 },
691 "node-image": {
692 "name": "node-image",
693 "type": "option",
694 "summary": "Custom Graph Node image to test against.",
695 "multiple": false,
696 "default": "graphprotocol/graph-node:latest"
697 },
698 "standalone-node": {
699 "name": "standalone-node",
700 "type": "option",
701 "summary": "Use a standalone Graph Node outside Docker Compose.",
702 "multiple": false
703 },
704 "standalone-node-args": {
705 "name": "standalone-node-args",
706 "type": "option",
707 "summary": "Custom arguments to be passed to the standalone Graph Node.",
708 "multiple": false,
709 "dependsOn": [
710 "standalone-node"
711 ]
712 },
713 "skip-wait-for-ipfs": {
714 "name": "skip-wait-for-ipfs",
715 "type": "boolean",
716 "summary": "Don't wait for IPFS to be up at localhost:15001",
717 "allowNo": false
718 },
719 "skip-wait-for-etherium": {
720 "name": "skip-wait-for-etherium",
721 "type": "boolean",
722 "summary": "Don't wait for Ethereum to be up at localhost:18545",
723 "allowNo": false
724 },
725 "skip-wait-for-postgres": {
726 "name": "skip-wait-for-postgres",
727 "type": "boolean",
728 "summary": "Don't wait for Postgres to be up at localhost:15432",
729 "allowNo": false
730 },
731 "timeout": {
732 "name": "timeout",
733 "type": "option",
734 "summary": "Time to wait for service containers in milliseconds.",
735 "multiple": false,
736 "default": 120000
737 }
738 },
739 "args": {
740 "local-command": {
741 "name": "local-command",
742 "required": true
743 }
744 }
745 },
746 "remove": {
747 "id": "remove",
748 "description": "Unregisters a subgraph name",
749 "strict": true,
750 "pluginName": "@graphprotocol/graph-cli",
751 "pluginAlias": "@graphprotocol/graph-cli",
752 "pluginType": "core",
753 "aliases": [],
754 "flags": {
755 "help": {
756 "name": "help",
757 "type": "boolean",
758 "char": "h",
759 "description": "Show CLI help.",
760 "allowNo": false
761 },
762 "node": {
763 "name": "node",
764 "type": "option",
765 "char": "g",
766 "summary": "Graph node to delete the subgraph from.",
767 "required": true,
768 "multiple": false
769 },
770 "access-token": {
771 "name": "access-token",
772 "type": "option",
773 "summary": "Graph access token.",
774 "multiple": false
775 }
776 },
777 "args": {
778 "subgraph-name": {
779 "name": "subgraph-name",
780 "required": true
781 }
782 }
783 },
784 "test": {
785 "id": "test",
786 "description": "Runs rust binary for subgraph testing.",
787 "strict": true,
788 "pluginName": "@graphprotocol/graph-cli",
789 "pluginAlias": "@graphprotocol/graph-cli",
790 "pluginType": "core",
791 "aliases": [],
792 "flags": {
793 "help": {
794 "name": "help",
795 "type": "boolean",
796 "char": "h",
797 "description": "Show CLI help.",
798 "allowNo": false
799 },
800 "coverage": {
801 "name": "coverage",
802 "type": "boolean",
803 "char": "c",
804 "summary": "Run the tests in coverage mode.",
805 "allowNo": false
806 },
807 "docker": {
808 "name": "docker",
809 "type": "boolean",
810 "char": "d",
811 "summary": "Run the tests in a docker container (Note: Please execute from the root folder of the subgraph).",
812 "allowNo": false
813 },
814 "force": {
815 "name": "force",
816 "type": "boolean",
817 "char": "f",
818 "summary": "Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image.",
819 "allowNo": false
820 },
821 "logs": {
822 "name": "logs",
823 "type": "boolean",
824 "char": "l",
825 "summary": "Logs to the console information about the OS, CPU model and download url (debugging purposes).",
826 "allowNo": false
827 },
828 "recompile": {
829 "name": "recompile",
830 "type": "boolean",
831 "char": "r",
832 "summary": "Force-recompile tests.",
833 "allowNo": false
834 },
835 "version": {
836 "name": "version",
837 "type": "option",
838 "char": "v",
839 "summary": "Choose the version of the rust binary that you want to be downloaded/used.",
840 "multiple": false
841 }
842 },
843 "args": {
844 "datasource": {
845 "name": "datasource"
846 }
847 }
848 }
849 }
850}
\No newline at end of file