You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-10Lines changed: 4 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,14 @@
1
1
# codacy-cli-v2
2
2
3
-
This is a POC for what could be a new CLI for us. The idea is to rely on the native tools and SARIF format instead of relying on Docker.
4
-
5
-
## Overview
6
-
7
-
The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing code using ESLint and uploading the results in SARIF format to Codacy. It provides two main commands: `analyze` and `upload`.
3
+
The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing code using tools like ESLint and uploading the results in SARIF format to Codacy. It provides two main commands: `analyze` and `upload`.
8
4
9
5
### Commands
10
6
11
7
-**`analyze` Command**: Runs ESLint analysis on the codebase.
12
8
-`--output, -o`: Output file for the results.
13
9
-`--tool, -t`: Specifies the tool to run analysis with (e.g., ESLint).
14
10
-`--format`: Output format (use 'sarif' for SARIF format to terminal).
15
-
-`--fix, -f`: Automatically fixes issues when possible.
16
-
-`--new-pr`: Creates a new GitHub PR with fixed issues.
11
+
-`--fix`: Automatically fixes issues when possible.
17
12
18
13
-**`upload` Command With Project Token**: Uploads a SARIF file containing analysis results to Codacy.
19
14
-`--sarif-path, -s`: Path to the SARIF report.
@@ -30,7 +25,7 @@ The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing co
30
25
31
26
### Important Concepts
32
27
33
-
-**`.codacy/codacy.yaml`**: Configuration file to specify `node` and `eslint` versions for the CLI.
28
+
-**`.codacy/codacy.yaml`**: Configuration file to specify runtimes and tools versions for the CLI.
0 commit comments