Skip to content

Commit 137ed8a

Browse files
chore: updating typegen README (FuelLabs#1561)
1 parent 1690004 commit 137ed8a

File tree

3 files changed

+21
-15
lines changed

3 files changed

+21
-15
lines changed

.changeset/good-timers-cry.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

apps/docs/src/guide/abi-typegen/generating-types-from-abi.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ $ pnpm fuels typegen -h
1717

1818
Usage: fuels typegen [options]
1919

20-
generate typescript from contract abi json files
20+
Generate Typescript from Sway ABI JSON files
2121

2222
Options:
23-
-i, --inputs <path|glob... input paths/globals to your ABI JSON files
24-
-o, --output <dir> directory path for generated files
25-
-c, --contract generate code for contracts [default]
26-
-s, --script generate code for scripts
27-
--silent omit output messages
28-
-h, --help display help for command
23+
-i, --inputs <path|glob...> Input paths/globals to your ABI JSON files
24+
-o, --output <dir> Directory path for generated files
25+
-c, --contract Generate types for Contracts [default]
26+
-s, --script Generate types for Scripts
27+
-p, --predicate Generate types for Predicates
28+
-S, --silent Omit output messages
29+
-h, --help Display help
2930
```
3031

3132
## Generating Types for Contracts

packages/abi-typegen/README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,26 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typeg
2424
```sh
2525
pnpm add @fuel-ts/abi-typegen
2626
# or
27-
nppnpmm add @fuel-ts/abi-typegen
27+
npm add @fuel-ts/abi-typegen
2828
```
2929

3030
## Help
3131

3232
```console
3333
$ fuels-typegen -h
34-
Usage: fuels-typegen [options]
3534

36-
generate typescript from contract abi json files
35+
Generate Typescript from Sway ABI JSON files
36+
37+
Usage: fuels-typegen [options]
3738

3839
Options:
39-
-i, --inputs <path|glob...> input paths/globals to your ABI JSON files
40-
-o, --output <dir> directory path for generated files
41-
-c, --contract generate types for contracts [default]
42-
-s, --script generate types for scripts
43-
--silent omit output messages
40+
-V, --version output the version number
41+
-i, --inputs <path|glob...> Input paths/globals to your ABI JSON files
42+
-o, --output <dir> Directory path for generated files
43+
-c, --contract Generate types for Contracts [default]
44+
-s, --script Generate types for Scripts
45+
-p, --predicate Generate types for Predicates
46+
-S, --silent Omit output messages
4447
-h, --help display help for command
4548
```
4649

0 commit comments

Comments
 (0)