Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): add tablegen to newdocs #1882

Merged
merged 2 commits into from
Nov 10, 2023
Merged

docs(cli): add tablegen to newdocs #1882

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb8670
docs(cli): add tablegen to newdocs
qbzzt Nov 8, 2023
652b0af
Update next-docs/pages/cli/tablegen.mdx
alvrs Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions next-docs/pages/cli/tablegen.mdx
View file
Open in desktop
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
```
Loading