-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(cli): add tablegen to new docs (#1882)
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# mud tablegen | ||
|
||
Autogenerate MUD Store table libraries based on the config file. | ||
|
||
## Sample usage | ||
|
||
Use the definitions in `mud.config.ts` to generate the Solidity definitions for tables and put them in `src/codegen/tables`, with an overall index that imports all the definitions in `src/codegen/index.sol`. | ||
|
||
## Options | ||
|
||
These are the command line options you can specify on `mud tablegen`: | ||
|
||
| Option | Meaning | Type | Default value | | ||
| -------------- | ----------------------- | ------- | --------------- | | ||
| `--version` | Show version number | boolean | false | | ||
| `--configPath` | Path to the config file | string | `mud.config.ts` | | ||
| `--help` | Show help | boolean | false | | ||
|
||
## Debugging | ||
|
||
To generate debug messages, use this command: | ||
|
||
```sh copy | ||
export DEBUG=mud:common:codegen | ||
``` |