Skip to content

Commit 2870f4d

Browse files
github-actions[bot]github-actions[bot]
committed
docs: sync README --help and Neo4j schema for v0.2.1
1 parent c02b92d commit 2870f4d

1 file changed

Lines changed: 106 additions & 58 deletions

File tree

‎README.md‎

Lines changed: 106 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -144,64 +144,112 @@ $ canpy --help
144144
145145
Static Analysis on Python source code using Jedi, CodeQL and Tree sitter.
146146
147-
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
148-
│ --input -i PATH Path to the project root directory │
149-
│ (not required for --emit schema). │
150-
│ --output -o PATH Output directory for artifacts. │
151-
│ --format -f [json|msgpack] Output format for --emit json: │
152-
│ json or msgpack. │
153-
│ [default: json] │
154-
│ --emit [json|neo4j|schema] Output target: json │
155-
│ (analysis.json, default) | neo4j │
156-
│ (graph.cypher or live Bolt push) | │
157-
│ schema (the Neo4j schema.json │
158-
│ contract). │
159-
│ [default: json] │
160-
│ --app-name TEXT Logical application name for the │
161-
│ graph :PyApplication anchor │
162-
│ (default: input dir name). │
163-
│ --neo4j-uri TEXT Push the graph to a live Neo4j │
164-
│ over Bolt (incremental); omit to │
165-
│ write graph.cypher. │
166-
│ [env var: NEO4J_URI] │
167-
│ --neo4j-user TEXT Neo4j username. │
168-
│ [env var: NEO4J_USERNAME] │
169-
│ [default: neo4j] │
170-
│ --neo4j-password TEXT Neo4j password. Prefer the env var │
171-
│ over the flag (the flag is visible │
172-
│ in shell history / process list). │
173-
│ [env var: NEO4J_PASSWORD] │
174-
│ [default: neo4j] │
175-
│ --neo4j-database TEXT Neo4j database name (default: │
176-
│ server default). │
177-
│ [env var: NEO4J_DATABASE] │
178-
│ --codeql --no-codeql Enable CodeQL-based analysis. │
179-
│ [default: no-codeql] │
180-
│ --ray --no-ray Enable Ray for distributed │
181-
│ analysis. │
182-
│ [default: no-ray] │
183-
│ --eager --lazy Enable eager or lazy analysis. │
184-
│ Defaults to lazy. │
185-
│ [default: lazy] │
186-
│ --skip-tests --include-tests Skip test files in analysis. │
187-
│ [default: skip-tests] │
188-
│ --no-venv --venv Skip virtualenv creation and │
189-
│ dependency installation; resolve │
190-
│ imports against the ambient Python │
191-
│ environment instead. │
192-
│ [default: venv] │
193-
│ --file-name PATH Analyze only the specified file │
194-
│ (relative to input directory). │
195-
│ --cache-dir -c PATH Directory to store analysis cache. │
196-
│ Defaults to '.codeanalyzer' in the │
197-
│ input directory. │
198-
│ --clear-cache --keep-cache Clear cache after analysis. By │
199-
│ default, cache is retained. │
200-
│ [default: keep-cache] │
201-
│ -v INTEGER Increase verbosity: -v, -vv, -vvv │
202-
│ [default: 0] │
203-
│ --help Show this message and exit. │
204-
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
147+
╭─ Options ────────────────────────────────────────────────────────────────────╮
148+
│ --input -i PATH Path to the │
149+
│ project root │
150+
│ directory (not │
151+
│ required for │
152+
│ --emit schema). │
153+
│ --output -o PATH Output directory │
154+
│ for artifacts. │
155+
│ --format -f [json|msgpack] Output format for │
156+
│ --emit json: json │
157+
│ or msgpack. │
158+
│ [default: json] │
159+
│ --emit [json|neo4j|sche Output target: │
160+
│ ma] json │
161+
│ (analysis.json, │
162+
│ default) | neo4j │
163+
│ (graph.cypher or │
164+
│ live Bolt push) | │
165+
│ schema (the Neo4j │
166+
│ schema.json │
167+
│ contract). │
168+
│ [default: json] │
169+
│ --app-name TEXT Logical │
170+
│ application name │
171+
│ for the graph │
172+
│ :PyApplication │
173+
│ anchor (default: │
174+
│ input dir name). │
175+
│ --neo4j-uri TEXT Push the graph to │
176+
│ a live Neo4j over │
177+
│ Bolt │
178+
│ (incremental); │
179+
│ omit to write │
180+
│ graph.cypher. │
181+
│ [env var: │
182+
│ NEO4J_URI] │
183+
│ --neo4j-user TEXT Neo4j username. │
184+
│ [env var: │
185+
│ NEO4J_USERNAME] │
186+
│ [default: neo4j] │
187+
│ --neo4j-password TEXT Neo4j password. │
188+
│ Prefer the env │
189+
│ var over the flag │
190+
│ (the flag is │
191+
│ visible in shell │
192+
│ history / process │
193+
│ list). │
194+
│ [env var: │
195+
│ NEO4J_PASSWORD] │
196+
│ [default: neo4j] │
197+
│ --neo4j-database TEXT Neo4j database │
198+
│ name (default: │
199+
│ server default). │
200+
│ [env var: │
201+
│ NEO4J_DATABASE] │
202+
│ --codeql --no-codeql Enable │
203+
│ CodeQL-based │
204+
│ analysis. │
205+
│ [default: │
206+
│ no-codeql] │
207+
│ --ray --no-ray Enable Ray for │
208+
│ distributed │
209+
│ analysis. │
210+
│ [default: no-ray] │
211+
│ --eager --lazy Enable eager or │
212+
│ lazy analysis. │
213+
│ Defaults to lazy. │
214+
│ [default: lazy] │
215+
│ --skip-tests --include-tests Skip test files │
216+
│ in analysis. │
217+
│ [default: │
218+
│ skip-tests] │
219+
│ --no-venv --venv Skip virtualenv │
220+
│ creation and │
221+
│ dependency │
222+
│ installation; │
223+
│ resolve imports │
224+
│ against the │
225+
│ ambient Python │
226+
│ environment │
227+
│ instead. │
228+
│ [default: venv] │
229+
│ --file-name PATH Analyze only the │
230+
│ specified file │
231+
│ (relative to │
232+
│ input directory). │
233+
│ --cache-dir -c PATH Directory to │
234+
│ store analysis │
235+
│ cache. Defaults │
236+
│ to │
237+
│ '.codeanalyzer' │
238+
│ in the input │
239+
│ directory. │
240+
│ --clear-cache --keep-cache Clear cache after │
241+
│ analysis. By │
242+
│ default, cache is │
243+
│ retained. │
244+
│ [default: │
245+
│ keep-cache] │
246+
│ -v INTEGER Increase │
247+
│ verbosity: -v, │
248+
│ -vv, -vvv │
249+
│ [default: 0] │
250+
│ --help Show this message │
251+
│ and exit. │
252+
╰──────────────────────────────────────────────────────────────────────────────╯
205253
```
206254

207255
<!-- END canpy-help -->

0 commit comments

Comments
 (0)