Skip to content

Commit 0196794

Browse files
committed
Update help in readme
Signed-off-by: Rahul Krishna <[email protected]>
1 parent 73d2241 commit 0196794

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,17 @@ To view the available options and commands, run `uv run codeanalyzer --help`. Yo
5252
Static Analysis on Python source code using Jedi, CodeQL and Tree sitter.
5353

5454

55-
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
56-
* --input -i PATH Path to the project root directory. [default: None] [required]
57-
│ --output -o PATH Output directory for artifacts. [default: None]
58-
│ --analysis-level -a INTEGER 1: symbol table, 2: call graph. [default: 1]
59-
│ --codeql --no-codeql Enable CodeQL-based analysis. [default: no-codeql]
60-
│ --eager --lazy Enable eager or lazy analysis. Eager will rebuild the analysis cache at every run and lazy will use the cache if available. Defaults to lazy. [default: lazy]
61-
│ --cache-dir -c PATH Directory to store analysis cache. If not specified, the cache will be stored in the current working directory under `.codeanalyzer`. Defaults to None. [default: None]
62-
│ --clear-cache --keep-cache Clear cache after analysis. [default: clear-cache]
63-
--verbose -v --quiet -q Enable verbose output. [default: v]
64-
│ --help Show this message and exit.
65-
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
55+
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
56+
* --input -i PATH Path to the project root directory. [default: None] [required] │
57+
│ --output -o PATH Output directory for artifacts. [default: None] │
58+
│ --analysis-level -a INTEGER 1: symbol table, 2: call graph. [default: 1] │
59+
│ --codeql --no-codeql Enable CodeQL-based analysis. [default: no-codeql] │
60+
│ --eager --lazy Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
61+
│ --cache-dir -c PATH Directory to store analysis cache. [default: None] │
62+
│ --clear-cache --keep-cache Clear cache after analysis. [default: clear-cache] │
63+
-v INTEGER Increase verbosity: -v, -vv, -vvv [default: 0]
64+
│ --help Show this message and exit. │
65+
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
6666
```
6767

6868
### Examples

RELEASE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## 🎉 CodeAnalyzer Python v0.1.0 Release
1+
## 🎉 Codeanalyzer Python v0.1.0 Release
22

33
**Python Static Analysis Backend for CodeLLM DevKit (CLDK)**
44

5-
Initial release of **CodeAnalyzer Python**: A comprehensive static analysis tool designed specifically as the Python backend for the CodeLLM DevKit ecosystem. This tool provides deep code understanding capabilities through symbol table generation, with future support for call graph analysis and semantic analysis using industry-standard tools.
5+
Initial release of **Codeanalyzer Python**: A comprehensive static analysis tool designed specifically as the Python backend for the CodeLLM DevKit ecosystem. This tool provides deep code understanding capabilities through symbol table generation, with future support for call graph analysis and semantic analysis using industry-standard tools.
66

77
### 🚀 Key Features
88

0 commit comments

Comments
 (0)