Skip to content

Commit d39c553

Browse files
github-actions[bot]github-actions[bot]
committed
docs: sync README --help and Neo4j schema for v0.2.0
1 parent 21b6a8b commit d39c553

1 file changed

Lines changed: 96 additions & 53 deletions

File tree

‎README.md‎

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

191234
<!-- END canpy-help -->

0 commit comments

Comments
 (0)