Skip to content

Commit 91369df

Browse files
github-actions[bot]julienrbrt
github-actions[bot]
and
julienrbrt
authored
docs(cli): update generated docs (#4787)
Co-authored-by: julienrbrt <29894366+julienrbrt@users.noreply.github.com>
1 parent 64c2d0b commit 91369df

File tree

1 file changed

+61
-13
lines changed

1 file changed

+61
-13
lines changed

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

Lines changed: 61 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2041,19 +2041,28 @@ Type definition
20412041

20422042
Type information
20432043

2044-
Currently supports:
2045-
2046-
| Type | Alias | Index | Code Type | Description |
2047-
|--------------|---------|-------|-----------|---------------------------------|
2048-
| string | - | yes | string | Text type |
2049-
| array.string | strings | no | []string | List of text type |
2050-
| bool | - | yes | bool | Boolean type |
2051-
| int | - | yes | int64 | Integer type |
2052-
| array.int | ints | no | []int64 | List of integers types |
2053-
| uint | - | yes | uint64 | Unsigned integer type |
2054-
| array.uint | uints | no | []uint64 | List of unsigned integers types |
2055-
| coin | - | no | sdk.Coin | Cosmos SDK coin type |
2056-
| array.coin | coins | no | sdk.Coins | List of Cosmos SDK coin types |
2044+
Types Usage
2045+
address use '<FIELD_NAME>:address' to scaffold string types (eg: cosmos1abcdefghijklmnopqrstuvwxyz0123456).
2046+
array.coin use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2047+
array.dec.coin use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2048+
array.int use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1).
2049+
array.string use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz).
2050+
array.uint use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40).
2051+
bool use '<FIELD_NAME>:bool' to scaffold bool types (eg: true).
2052+
bytes use '<FIELD_NAME>:bytes' to scaffold []byte types (eg: 3,2,3,5).
2053+
coin use '<FIELD_NAME>:coin' to scaffold sdk.Coin types (eg: 10token).
2054+
coins use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2055+
custom use the custom type to scaffold already created chain types.
2056+
dec.coin use '<FIELD_NAME>:dec.coin' to scaffold sdk.DecCoin types (eg: 100001token).
2057+
dec.coins use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2058+
int use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111).
2059+
int64 use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111).
2060+
ints use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1).
2061+
string use '<FIELD_NAME>:string' to scaffold string types (eg: xyz).
2062+
strings use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz).
2063+
uint use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111).
2064+
uint64 use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111).
2065+
uints use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40).
20572066

20582067
Field Usage:
20592068
- fieldName
@@ -2312,3 +2321,42 @@ ignite version [flags]
23122321

23132322
* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain
23142323

2324+
# Scaffold Type
2325+
2326+
Ignites provides a set of scaffold types that can be used to generate code for your application.
2327+
These types are used in the `ignite scaffold` command.
2328+
2329+
## Available Scaffold Types
2330+
2331+
| Type | Usage |
2332+
| --- | --- |
2333+
| address | use '<FIELD_NAME>:address' to scaffold string types (eg: cosmos1abcdefghijklmnopqrstuvwxyz0123456). |
2334+
| array.coin | use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2335+
| array.dec.coin | use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2336+
| array.int | use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1). |
2337+
| array.string | use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz). |
2338+
| array.uint | use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40). |
2339+
| bool | use '<FIELD_NAME>:bool' to scaffold bool types (eg: true). |
2340+
| bytes | use '<FIELD_NAME>:bytes' to scaffold []byte types (eg: 3,2,3,5). |
2341+
| coin | use '<FIELD_NAME>:coin' to scaffold sdk.Coin types (eg: 10token). |
2342+
| coins | use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2343+
| custom | use the custom type to scaffold already created chain types. |
2344+
| dec.coin | use '<FIELD_NAME>:dec.coin' to scaffold sdk.DecCoin types (eg: 100001token). |
2345+
| dec.coins | use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2346+
| int | use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111). |
2347+
| int64 | use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111). |
2348+
| ints | use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1). |
2349+
| string | use '<FIELD_NAME>:string' to scaffold string types (eg: xyz). |
2350+
| strings | use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz). |
2351+
| uint | use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111). |
2352+
| uint64 | use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111). |
2353+
| uints | use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40). |
2354+
2355+
2356+
Field Usage:
2357+
2358+
- fieldName
2359+
- fieldName:fieldType
2360+
2361+
2362+
If no :fieldType, default (string) is used

0 commit comments

Comments
 (0)