Manage and run DipDup indexers.
Full docs: https://docs.dipdup.io
Report an issue: https://github.com/dipdup-net/dipdup/issues
dipdup [OPTIONS] COMMAND [ARGS]...
Show the version and exit.
- -c, --config <config>¶
A path to DipDup project config (default: dipdup.yml).
- -e, --env-file <env_file>¶
A path to .env file containing KEY=value strings.
Commands to manage DipDup configuration.
dipdup config [OPTIONS] COMMAND [ARGS]...
Dump environment variables used in DipDup config.
If variable is not set, default value will be used.
dipdup config env [OPTIONS]
- -f, --file <file>¶
Output to file instead of stdout.
Print config after resolving all links and, optionally, templates.
WARNING: Avoid sharing output with 3rd-parties when –unsafe flag set - it may contain secrets!
dipdup config export [OPTIONS]
Resolve environment variables or use default values from config.
Resolve index templates.
Hasura integration related commands.
dipdup hasura [OPTIONS] COMMAND [ARGS]...
Configure Hasura GraphQL Engine to use with DipDup.
dipdup hasura configure [OPTIONS]
Proceed even if Hasura is already configured.
Generate project tree, missing callbacks and types.
This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.
dipdup init [OPTIONS]
Regenerate existing types.
Do not remove JSONSchemas after generating types.
Migrate project to the new spec version.
If you’re getting MigrationRequiredError after updating DipDup, this command will fix imports and type annotations to match the current spec_version. Review and commit changes after running it.
dipdup migrate [OPTIONS]
Execution can be gracefully interrupted with Ctrl+C or SIGTERM signal.
dipdup run [OPTIONS]
Manage database schema.
dipdup schema [OPTIONS] COMMAND [ARGS]...
Continue to use existing schema after reindexing was triggered.
dipdup schema approve [OPTIONS]
Print SQL schema including scripts from sql/on_reindex.
This command may help you debug inconsistency between project models and expected SQL schema.
dipdup schema export [OPTIONS]
Prepare a database for running DipDip.
This command creates tables based on your models, then executes sql/on_reindex to finish preparation - the same things DipDup does when run on a clean database.
dipdup schema init [OPTIONS]
Drop all database tables, functions and views.
WARNING: This action is irreversible! All indexed data will be lost!
dipdup schema wipe [OPTIONS]
Drop immune tables too.
Skip confirmation prompt.
Show the current status of indexes in the database.
dipdup status [OPTIONS]