@@ -164,19 +164,19 @@ $ canpy --help
164164│ --version Show the canpy │
165165│ version and │
166166│ exit. │
167- │ --input -i PATH Path to the │
167+ │ --input -i <path> Path to the │
168168│ project root │
169169│ directory (not │
170170│ required for │
171171│ --emit schema). │
172- │ --output -o PATH Output directory │
172+ │ --output -o <path> Output directory │
173173│ for artifacts. │
174- │ --format -f [ json|msgpack] Output format │
174+ │ --format -f < json|msgpack> Output format │
175175│ for --emit json: │
176176│ json or msgpack. │
177177│ [default: json] │
178- │ --emit [ json|neo4j|sche Output target: │
179- │ ma] json │
178+ │ --emit < json|neo4j|sche Output target: │
179+ │ ma> json │
180180│ (analysis.json, │
181181│ default) | neo4j │
182182│ (graph.cypher or │
@@ -186,25 +186,25 @@ $ canpy --help
186186│ schema.json │
187187│ contract). │
188188│ [default: json] │
189- │ --app-name TEXT Logical │
189+ │ --app-name <str> Logical │
190190│ application name │
191191│ for the graph │
192192│ :PyApplication │
193193│ anchor (default: │
194194│ input dir name). │
195- │ --neo4j-uri TEXT Push the graph │
195+ │ --neo4j-uri <str> Push the graph │
196196│ to a live Neo4j │
197197│ over Bolt │
198198│ (incremental); │
199199│ omit to write │
200200│ graph.cypher. │
201201│ [env var: │
202202│ NEO4J_URI] │
203- │ --neo4j-user TEXT Neo4j username. │
203+ │ --neo4j-user <str> Neo4j username. │
204204│ [env var: │
205205│ NEO4J_USERNAME] │
206206│ [default: neo4j] │
207- │ --neo4j-password TEXT Neo4j password. │
207+ │ --neo4j-password <str> Neo4j password. │
208208│ Prefer the env │
209209│ var over the │
210210│ flag (the flag │
@@ -214,12 +214,12 @@ $ canpy --help
214214│ [env var: │
215215│ NEO4J_PASSWORD] │
216216│ [default: neo4j] │
217- │ --neo4j-database TEXT Neo4j database │
217+ │ --neo4j-database <str> Neo4j database │
218218│ name (default: │
219219│ server default). │
220220│ [env var: │
221221│ NEO4J_DATABASE] │
222- │ --analysis-level -a INTEGER RANGE Analysis depth: │
222+ │ --analysis-level -a <int range> Analysis depth: │
223223│ [1<=x<=4] 1=symbol │
224224│ table+Jedi call │
225225│ graph, 2=+PyCG │
@@ -235,7 +235,7 @@ $ canpy --help
235235│ alias-aware │
236236│ DDG). │
237237│ [default: 1] │
238- │ --graphs TEXT Level 3+ only: │
238+ │ --graphs <str> Level 3+ only: │
239239│ comma-separated │
240240│ program-graph │
241241│ sections to emit │
@@ -248,7 +248,7 @@ $ canpy --help
248248│ requires -a 4. │
249249│ [default: │
250250│ cfg,dfg,pdg] │
251- │ --graph-field-de… INTEGER RANGE Level 3 only: │
251+ │ --graph-field-de… <int range> Level 3 only: │
252252│ [x>=1] k-limit on │
253253│ access-path │
254254│ depth (x.f.g.h │
@@ -285,12 +285,12 @@ $ canpy --help
285285│ environment │
286286│ instead. │
287287│ [default: venv] │
288- │ --file-name PATH Analyze only the │
288+ │ --file-name <path> Analyze only the │
289289│ specified file │
290290│ (relative to │
291291│ input │
292292│ directory). │
293- │ --cache-dir -c PATH Directory to │
293+ │ --cache-dir -c <path> Directory to │
294294│ store analysis │
295295│ cache. Defaults │
296296│ to │
@@ -304,7 +304,7 @@ $ canpy --help
304304│ retained. │
305305│ [default: │
306306│ keep-cache] │
307- │ -v INTEGER Increase │
307+ │ -v <int> Increase │
308308│ verbosity: -v, │
309309│ -vv, -vvv │
310310│ [default: 0] │
@@ -331,7 +331,7 @@ $ canpy --help
331331│ Jedi-only edges. │
332332│ [default: │
333333│ no-pycg-shard] │
334- │ --pycg-shard-cei… INTEGER RANGE Maximum files │
334+ │ --pycg-shard-cei… <int range> Maximum files │
335335│ [x>=1] per shard when │
336336│ --pycg-shard is │
337337│ active (default │
@@ -353,7 +353,7 @@ $ canpy --help
353353│ heavy import │
354354│ graphs. │
355355│ [default: 100] │
356- │ --pycg-shard-tim… INTEGER RANGE Per-shard │
356+ │ --pycg-shard-tim… <int range> Per-shard │
357357│ [x>=0] wall-clock │
358358│ timeout in │
359359│ seconds when │
@@ -381,7 +381,7 @@ $ canpy --help
381381│ ignored on │
382382│ Windows. │
383383│ [default: 120] │
384- │ --pycg-shard-str… [ jedi|package] How --pycg-shard │
384+ │ --pycg-shard-str… < jedi|package> How --pycg-shard │
385385│ groups files │
386386│ (level 2 only). │
387387│ 'jedi' (default) │
@@ -403,7 +403,7 @@ $ canpy --help
403403│ one-shard-per-p… │
404404│ grouping. │
405405│ [default: jedi] │
406- │ --pycg-max-iter INTEGER RANGE Cap on PyCG's │
406+ │ --pycg-max-iter <int range> Cap on PyCG's │
407407│ [x>=-1] fixpoint passes │
408408│ per │
409409│ shard/project │
0 commit comments