Skip to content

Commit

Permalink
docs(cli): add tablegen to new docs (#1882)
Browse files Browse the repository at this point in the history
  • Loading branch information
qbzzt authored Nov 10, 2023
1 parent 3dc2500 commit e7881a8
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions next-docs/pages/cli/tablegen.mdx
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
```

0 comments on commit e7881a8

Please sign in to comment.