@@ -25,6 +25,7 @@ description: "Command-line interface reference"
2525<dt >/_____//_// .___//_____/ __,_// .___/</dt ><dd ><p >/_/ /_/</p >
2626</dd >
2727</dl >
28+ <p class =" rubric " >Usage</p >
2829<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
2930</pre ></div >
3031</div >
@@ -78,6 +79,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
7879## config
7980
8081<p >Commands to manage DipDup configuration.</p >
82+ <p class =" rubric " >Usage</p >
8183<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >config<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
8284</pre ></div >
8385</div >
@@ -87,6 +89,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
8789
8890<p >Dump environment variables used in DipDup config.</p >
8991<p >If variable is not set, default value will be used.</p >
92+ <p class =" rubric " >Usage</p >
9093<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >config<span class =" w " > </span >env<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
9194</pre ></div >
9295</div >
@@ -122,6 +125,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
122125
123126<p >Print config after resolving all links and, optionally, templates.</p >
124127<p >WARNING: Avoid sharing output with 3rd-parties when <cite >–unsafe</cite > flag set - it may contain secrets!</p >
128+ <p class =" rubric " >Usage</p >
125129<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >config<span class =" w " > </span ><span class =" nb " >export</span ><span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
126130</pre ></div >
127131</div >
@@ -151,6 +155,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
151155## hasura
152156
153157<p >Commands related to Hasura integration.</p >
158+ <p class =" rubric " >Usage</p >
154159<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >hasura<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
155160</pre ></div >
156161</div >
@@ -159,6 +164,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
159164### configure
160165
161166<p >Configure Hasura GraphQL Engine to use with DipDup.</p >
167+ <p class =" rubric " >Usage</p >
162168<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >hasura<span class =" w " > </span >configure<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
163169</pre ></div >
164170</div >
@@ -177,6 +183,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
177183
178184<p >Generate project tree, typeclasses and callback stubs.</p >
179185<p >This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.</p >
186+ <p class =" rubric " >Usage</p >
180187<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >init<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >PATH
181188</pre ></div >
182189</div >
@@ -224,6 +231,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
224231## mcp
225232
226233<p >Commands related to MCP integration.</p >
234+ <p class =" rubric " >Usage</p >
227235<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >mcp<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
228236</pre ></div >
229237</div >
@@ -232,6 +240,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
232240### run
233241
234242<p >Run MCP server.</p >
243+ <p class =" rubric " >Usage</p >
235244<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >mcp<span class =" w " > </span >run<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
236245</pre ></div >
237246</div >
@@ -243,6 +252,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
243252
244253<p >Migrate project to the new spec version.</p >
245254<p >If you’re getting <cite >MigrationRequiredError</cite > after updating DipDup, this command will fix imports and type annotations to match the current <cite >spec_version</cite >. Review and commit changes after running it.</p >
255+ <p class =" rubric " >Usage</p >
246256<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >migrate<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
247257</pre ></div >
248258</div >
@@ -259,6 +269,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
259269## new
260270
261271<p >Create a new project interactively.</p >
272+ <p class =" rubric " >Usage</p >
262273<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >new<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
263274</pre ></div >
264275</div >
@@ -299,6 +310,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
299310## package
300311
301312<p >Inspect and manage project package.</p >
313+ <p class =" rubric " >Usage</p >
302314<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >package<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
303315</pre ></div >
304316</div >
@@ -307,6 +319,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
307319### tree
308320
309321<p >Draw package tree.</p >
322+ <p class =" rubric " >Usage</p >
310323<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >package<span class =" w " > </span >tree<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
311324</pre ></div >
312325</div >
@@ -316,6 +329,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
316329### verify
317330
318331<p >Verify project package.</p >
332+ <p class =" rubric " >Usage</p >
319333<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >package<span class =" w " > </span >verify<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
320334</pre ></div >
321335</div >
@@ -326,6 +340,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
326340## report
327341
328342<p >Manage crash and performance reports.</p >
343+ <p class =" rubric " >Usage</p >
329344<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >report<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
330345</pre ></div >
331346</div >
@@ -334,6 +349,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
334349### ls
335350
336351<p >List reports.</p >
352+ <p class =" rubric " >Usage</p >
337353<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >report<span class =" w " > </span >ls<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
338354</pre ></div >
339355</div >
@@ -343,6 +359,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
343359### rm
344360
345361<p >Remove report(s).</p >
362+ <p class =" rubric " >Usage</p >
346363<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >report<span class =" w " > </span >rm<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span ><span class =" o " >[</span >ID<span class =" o " >]</span >
347364</pre ></div >
348365</div >
@@ -366,6 +383,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
366383### show
367384
368385<p >Show report.</p >
386+ <p class =" rubric " >Usage</p >
369387<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >report<span class =" w " > </span >show<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >ID
370388</pre ></div >
371389</div >
@@ -384,6 +402,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
384402
385403<p >Run the indexer.</p >
386404<p >Execution can be gracefully interrupted with <cite >Ctrl+C</cite > or <cite >SIGINT</cite > signal.</p >
405+ <p class =" rubric " >Usage</p >
387406<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >run<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
388407</pre ></div >
389408</div >
@@ -393,6 +412,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
393412## schema
394413
395414<p >Commands to manage database schema.</p >
415+ <p class =" rubric " >Usage</p >
396416<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >schema<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
397417</pre ></div >
398418</div >
@@ -401,6 +421,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
401421### approve
402422
403423<p >Continue to use existing schema after reindexing was triggered.</p >
424+ <p class =" rubric " >Usage</p >
404425<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >schema<span class =" w " > </span >approve<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
405426</pre ></div >
406427</div >
@@ -411,6 +432,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
411432
412433<p >Print SQL schema including scripts from <cite >sql/on_reindex</cite >.</p >
413434<p >This command may help you debug inconsistency between project models and expected SQL schema.</p >
435+ <p class =" rubric " >Usage</p >
414436<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >schema<span class =" w " > </span ><span class =" nb " >export</span ><span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
415437</pre ></div >
416438</div >
@@ -421,6 +443,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
421443
422444<p >Prepare database schema for running DipDup.</p >
423445<p >This command creates tables based on your models, then executes <cite >sql/on_reindex</cite > to finish preparation - the same things DipDup does when run on a clean database.</p >
446+ <p class =" rubric " >Usage</p >
424447<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >schema<span class =" w " > </span >init<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
425448</pre ></div >
426449</div >
@@ -431,6 +454,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
431454
432455<p >Drop all database tables, functions and views.</p >
433456<p >WARNING: This action is irreversible! All indexed data will be lost!</p >
457+ <p class =" rubric " >Usage</p >
434458<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >schema<span class =" w " > </span >wipe<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
435459</pre ></div >
436460</div >
@@ -454,6 +478,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
454478## self
455479
456480<p >Commands to manage local DipDup installation.</p >
481+ <p class =" rubric " >Usage</p >
457482<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >self<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span ><span class =" w " > </span >COMMAND<span class =" w " > </span ><span class =" o " >[</span >ARGS<span class =" o " >]</span >...
458483</pre ></div >
459484</div >
@@ -462,6 +487,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
462487### install
463488
464489<p >Install DipDup for the current user.</p >
490+ <p class =" rubric " >Usage</p >
465491<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >self<span class =" w " > </span >install<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
466492</pre ></div >
467493</div >
@@ -514,6 +540,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
514540### uninstall
515541
516542<p >Uninstall DipDup for the current user.</p >
543+ <p class =" rubric " >Usage</p >
517544<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >self<span class =" w " > </span >uninstall<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
518545</pre ></div >
519546</div >
@@ -530,6 +557,7 @@ Discord: <a class="reference external" href="https://discord.gg/aG
530557### update
531558
532559<p >Update DipDup for the current user.</p >
560+ <p class =" rubric " >Usage</p >
533561<div class =" highlight-shell notranslate " ><div class =" highlight " ><pre ><span ></span >dipdup<span class =" w " > </span >self<span class =" w " > </span >update<span class =" w " > </span ><span class =" o " >[</span >OPTIONS<span class =" o " >]</span >
534562</pre ></div >
535563</div >
0 commit comments