Table of Contents

config

env

export

hasura

CLI reference

dipdup

: ____ _ ____
/ __ (_)____ / __ __ __ ____
/ / / // // __ / / / // / / // __
/ /_/ // // /_/ // /_/ // /_/ // /_/ /
/_____//_// .___//_____/ __,_// .___/: /_/ /_/

dipdup [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

-c, --config <PATH>: A path to DipDup project config.

-e, --env-file <PATH>: A path to .env file containing KEY=value strings.

-C <NAME>: A shorthand for -c . -c configs/dipdup.<name>.yaml

Environment variables

DIPDUP_CONFIG: Provide a default for --config

DIPDUP_ENV_FILE: Provide a default for --env-file

Documentation: https://dipdup.io/docs GitHub: https://github.com/dipdup-io/dipdup Discord: https://discord.gg/aG8XKuwsQd

config

Commands to manage DipDup configuration.

dipdup config [OPTIONS] COMMAND [ARGS]...

env

Dump environment variables used in DipDup config.

If variable is not set, default value will be used.

dipdup config env [OPTIONS]

Options

-o, --output <output>: Output to file instead of stdout.

--unsafe: Use actual environment variables instead of default values.

-c, --compose: Output in docker-compose format.

-i, --internal: Include internal variables.

export

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]

Options

--unsafe: Use actual environment variables instead of default values.

-f, --full: Resolve index templates.

-r, --raw: Do not initialize config; preserve file structure.

hasura

Commands related to Hasura integration.

dipdup hasura [OPTIONS] COMMAND [ARGS]...

configure

Configure Hasura GraphQL Engine to use with DipDup.

dipdup hasura configure [OPTIONS]

Options

-f, --force: Proceed even if Hasura is already configured.

init

Generate project tree, typeclasses and callback stubs.

This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.

dipdup init [OPTIONS] PATH

Options

-f, --force: Overwrite existing types and ABIs.

-b, --base: Include template base: pyproject.toml, Dockerfile, etc.

Arguments

PATH: Optional argument(s)

migrate

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]

Options

-n, --dry-run: Print changes without applying them.

new

Create a new project interactively.

dipdup new [OPTIONS]

Options

-q, --quiet: Use default values for all prompts.

-f, --force: Overwrite existing files.

-r, --replay <replay>: Use values from a replay file.

-t, --template <template>: Use a specific template.

package

Inspect and manage project package.

dipdup package [OPTIONS] COMMAND [ARGS]...

tree

Draw package tree.

dipdup package tree [OPTIONS]

verify

Verify project package.

dipdup package verify [OPTIONS]

report

Manage crash and performance reports.

dipdup report [OPTIONS] COMMAND [ARGS]...

ls

List reports.

dipdup report ls [OPTIONS]

rm

Remove report(s).

dipdup report rm [OPTIONS] [ID]

Options

-a, --all: Remove all reports.

Arguments

ID: Optional argument

show

Show report.

dipdup report show [OPTIONS] ID

Arguments

ID: Required argument

run

Run the indexer.

Execution can be gracefully interrupted with Ctrl+C or SIGINT signal.

dipdup run [OPTIONS]

schema

Commands to manage database schema.

dipdup schema [OPTIONS] COMMAND [ARGS]...

approve

Continue to use existing schema after reindexing was triggered.

dipdup schema approve [OPTIONS]

export

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]

init

Prepare database schema for running DipDup.

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.