Skip to content

Commit d39cd6d

Browse files
docs(cli): update generated docs (#4724)
Co-authored-by: julienrbrt <[email protected]>
1 parent ef864aa commit d39cd6d

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/docs/03-CLI-Commands/01-cli-commands.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,6 +1032,7 @@ meant to be edited by hand.
10321032
* [ignite generate hooks](#ignite-generate-hooks) - TypeScript frontend client and React hooks
10331033
* [ignite generate openapi](#ignite-generate-openapi) - OpenAPI spec for your chain
10341034
* [ignite generate proto-go](#ignite-generate-proto-go) - Compile protocol buffer files to Go source code required by Cosmos SDK
1035+
* [ignite generate ts-client](#ignite-generate-ts-client) - TypeScript frontend client
10351036

10361037

10371038
## ignite generate composables
@@ -1152,6 +1153,58 @@ ignite generate proto-go [flags]
11521153
* [ignite generate](#ignite-generate) - Generate clients, API docs from source code
11531154

11541155

1156+
## ignite generate ts-client
1157+
1158+
TypeScript frontend client
1159+
1160+
**Synopsis**
1161+
1162+
Generate a framework agnostic TypeScript client for your blockchain project.
1163+
1164+
By default the TypeScript client is generated in the "ts-client/" directory. You
1165+
can customize the output directory in config.yml:
1166+
1167+
client:
1168+
typescript:
1169+
path: new-path
1170+
1171+
Output can also be customized by using a flag:
1172+
1173+
ignite generate ts-client --output new-path
1174+
1175+
TypeScript client code can be automatically regenerated on reset or source code
1176+
changes when the blockchain is started with a flag:
1177+
1178+
ignite chain serve --generate-clients
1179+
1180+
1181+
```
1182+
ignite generate ts-client [flags]
1183+
```
1184+
1185+
**Options**
1186+
1187+
```
1188+
-h, --help help for ts-client
1189+
-o, --output string TypeScript client output path
1190+
--use-cache use build cache to speed-up generation
1191+
-y, --yes answers interactive yes/no questions with yes
1192+
```
1193+
1194+
**Options inherited from parent commands**
1195+
1196+
```
1197+
--clear-cache clear the build cache (advanced)
1198+
--enable-proto-vendor enable proto package vendor for missing Buf dependencies
1199+
-p, --path string path of the app (default ".")
1200+
-v, --verbose verbose output
1201+
```
1202+
1203+
**SEE ALSO**
1204+
1205+
* [ignite generate](#ignite-generate) - Generate clients, API docs from source code
1206+
1207+
11551208
## ignite relayer
11561209

11571210
Connect blockchains with an IBC relayer

0 commit comments

Comments
 (0)