|
4 | 4 | <p>Manage and run DipDup indexers.</p> |
5 | 5 | <p>Documentation: <a class="reference external" href="https://docs.dipdup.io">https://docs.dipdup.io</a></p> |
6 | 6 | <p>Issues: <a class="reference external" href="https://github.com/dipdup-io/dipdup/issues">https://github.com/dipdup-io/dipdup/issues</a></p> |
7 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| 7 | +<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>... |
8 | 8 | </pre></div> |
9 | 9 | </div> |
10 | 10 | <p class="rubric">Options</p> |
|
29 | 29 | <section id="dipdup-config"> |
30 | 30 | <h2>config<a class="headerlink" href="#dipdup-config" title="Permalink to this heading">¶</a></h2> |
31 | 31 | <p>Commands to manage DipDup configuration.</p> |
32 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| 32 | +<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>... |
33 | 33 | </pre></div> |
34 | 34 | </div> |
35 | 35 | <section id="dipdup-config-env"> |
36 | 36 | <h3>env<a class="headerlink" href="#dipdup-config-env" title="Permalink to this heading">¶</a></h3> |
37 | 37 | <p>Dump environment variables used in DipDup config.</p> |
38 | 38 | <p>If variable is not set, default value will be used.</p> |
39 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config env <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 39 | +<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> |
40 | 40 | </pre></div> |
41 | 41 | </div> |
42 | 42 | <p class="rubric">Options</p> |
|
51 | 51 | <h3>export<a class="headerlink" href="#dipdup-config-export" title="Permalink to this heading">¶</a></h3> |
52 | 52 | <p>Print config after resolving all links and, optionally, templates.</p> |
53 | 53 | <p>WARNING: Avoid sharing output with 3rd-parties when <cite>–unsafe</cite> flag set - it may contain secrets!</p> |
54 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup config <span class="nb">export</span> <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 54 | +<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> |
55 | 55 | </pre></div> |
56 | 56 | </div> |
57 | 57 | <p class="rubric">Options</p> |
|
72 | 72 | <section id="dipdup-hasura"> |
73 | 73 | <h2>hasura<a class="headerlink" href="#dipdup-hasura" title="Permalink to this heading">¶</a></h2> |
74 | 74 | <p>Commands related to Hasura integration.</p> |
75 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup hasura <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| 75 | +<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>... |
76 | 76 | </pre></div> |
77 | 77 | </div> |
78 | 78 | <section id="dipdup-hasura-configure"> |
79 | 79 | <h3>configure<a class="headerlink" href="#dipdup-hasura-configure" title="Permalink to this heading">¶</a></h3> |
80 | 80 | <p>Configure Hasura GraphQL Engine to use with DipDup.</p> |
81 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup hasura configure <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 81 | +<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> |
82 | 82 | </pre></div> |
83 | 83 | </div> |
84 | 84 | <p class="rubric">Options</p> |
|
94 | 94 | <h2>init<a class="headerlink" href="#dipdup-init" title="Permalink to this heading">¶</a></h2> |
95 | 95 | <p>Generate project tree, callbacks and types.</p> |
96 | 96 | <p>This command is idempotent, meaning it won’t overwrite previously generated files unless asked explicitly.</p> |
97 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup init <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 97 | +<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> |
98 | 98 | </pre></div> |
99 | 99 | </div> |
100 | 100 | <p class="rubric">Options</p> |
|
114 | 114 | <section id="dipdup-install"> |
115 | 115 | <h2>install<a class="headerlink" href="#dipdup-install" title="Permalink to this heading">¶</a></h2> |
116 | 116 | <p>Install DipDup for the current user.</p> |
117 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup install <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 117 | +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>install<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span> |
118 | 118 | </pre></div> |
119 | 119 | </div> |
120 | 120 | <p class="rubric">Options</p> |
|
147 | 147 | <h2>migrate<a class="headerlink" href="#dipdup-migrate" title="Permalink to this heading">¶</a></h2> |
148 | 148 | <p>Migrate project to the new spec version.</p> |
149 | 149 | <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> |
150 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup migrate <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 150 | +<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> |
151 | 151 | </pre></div> |
152 | 152 | </div> |
153 | 153 | </section> |
154 | 154 | <section id="dipdup-new"> |
155 | 155 | <h2>new<a class="headerlink" href="#dipdup-new" title="Permalink to this heading">¶</a></h2> |
156 | 156 | <p>Create a new project interactively.</p> |
157 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup new <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 157 | +<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> |
158 | 158 | </pre></div> |
159 | 159 | </div> |
160 | 160 | <p class="rubric">Options</p> |
|
181 | 181 | <h2>run<a class="headerlink" href="#dipdup-run" title="Permalink to this heading">¶</a></h2> |
182 | 182 | <p>Run indexer.</p> |
183 | 183 | <p>Execution can be gracefully interrupted with <cite>Ctrl+C</cite> or <cite>SIGTERM</cite> signal.</p> |
184 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup run <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 184 | +<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> |
185 | 185 | </pre></div> |
186 | 186 | </div> |
187 | 187 | </section> |
188 | 188 | <section id="dipdup-schema"> |
189 | 189 | <h2>schema<a class="headerlink" href="#dipdup-schema" title="Permalink to this heading">¶</a></h2> |
190 | 190 | <p>Commands to manage database schema.</p> |
191 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| 191 | +<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>... |
192 | 192 | </pre></div> |
193 | 193 | </div> |
194 | 194 | <section id="dipdup-schema-approve"> |
195 | 195 | <h3>approve<a class="headerlink" href="#dipdup-schema-approve" title="Permalink to this heading">¶</a></h3> |
196 | 196 | <p>Continue to use existing schema after reindexing was triggered.</p> |
197 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema approve <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 197 | +<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> |
198 | 198 | </pre></div> |
199 | 199 | </div> |
200 | 200 | </section> |
201 | 201 | <section id="dipdup-schema-export"> |
202 | 202 | <h3>export<a class="headerlink" href="#dipdup-schema-export" title="Permalink to this heading">¶</a></h3> |
203 | 203 | <p>Print SQL schema including scripts from <cite>sql/on_reindex</cite>.</p> |
204 | 204 | <p>This command may help you debug inconsistency between project models and expected SQL schema.</p> |
205 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema <span class="nb">export</span> <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 205 | +<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> |
206 | 206 | </pre></div> |
207 | 207 | </div> |
208 | 208 | </section> |
209 | 209 | <section id="dipdup-schema-init"> |
210 | 210 | <h3>init<a class="headerlink" href="#dipdup-schema-init" title="Permalink to this heading">¶</a></h3> |
211 | 211 | <p>Prepare a database for running DipDip.</p> |
212 | 212 | <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> |
213 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema init <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 213 | +<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> |
214 | 214 | </pre></div> |
215 | 215 | </div> |
216 | 216 | </section> |
217 | 217 | <section id="dipdup-schema-wipe"> |
218 | 218 | <h3>wipe<a class="headerlink" href="#dipdup-schema-wipe" title="Permalink to this heading">¶</a></h3> |
219 | 219 | <p>Drop all database tables, functions and views.</p> |
220 | 220 | <p>WARNING: This action is irreversible! All indexed data will be lost!</p> |
221 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup schema wipe <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 221 | +<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> |
222 | 222 | </pre></div> |
223 | 223 | </div> |
224 | 224 | <p class="rubric">Options</p> |
|
239 | 239 | <section id="dipdup-status"> |
240 | 240 | <h2>status<a class="headerlink" href="#dipdup-status" title="Permalink to this heading">¶</a></h2> |
241 | 241 | <p>Show the current status of indexes in the database.</p> |
242 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup status <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 242 | +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>status<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span> |
243 | 243 | </pre></div> |
244 | 244 | </div> |
245 | 245 | </section> |
246 | 246 | <section id="dipdup-uninstall"> |
247 | 247 | <h2>uninstall<a class="headerlink" href="#dipdup-uninstall" title="Permalink to this heading">¶</a></h2> |
248 | 248 | <p>Uninstall DipDup for the current user.</p> |
249 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup uninstall <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 249 | +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>uninstall<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span> |
250 | 250 | </pre></div> |
251 | 251 | </div> |
252 | 252 | <p class="rubric">Options</p> |
|
260 | 260 | <section id="dipdup-update"> |
261 | 261 | <h2>update<a class="headerlink" href="#dipdup-update" title="Permalink to this heading">¶</a></h2> |
262 | 262 | <p>Update DipDup for the current user.</p> |
263 | | -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup update <span class="o">[</span>OPTIONS<span class="o">]</span> |
| 263 | +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dipdup<span class="w"> </span>update<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span> |
264 | 264 | </pre></div> |
265 | 265 | </div> |
266 | 266 | <p class="rubric">Options</p> |
|
0 commit comments