Skip to content

doc: Add Troubleshotting section + clean up #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
machadoit merged 1 commit into from
Apr 14, 2025
Merged

doc: Add Troubleshotting section + clean up #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To install `codacy-cli` using Homebrew:
brew install codacy/codacy-cli-v2/codacy-cli-v2
```

## Linux
### Linux

For Linux, we rely on the codacy-cli.sh script in the root. To download the CLI, run:

Expand All @@ -66,7 +66,7 @@ Before running the analysis, install the specified tools:
codacy-cli install
```

### Run Analysis
## Run Analysis

To run ESLint and output the results to the terminal:

Expand Down Expand Up @@ -102,6 +102,16 @@ Some behaviors have changed with the new updates of the CLI. To rely on a specif
export CODACY_CLI_V2_VERSION="1.0.0-main.133.3607792"
```

### Example Repository
## Example Repository

As an example, you can check https://github.com/troubleshoot-codacy/eslint-test-examples for a repository that has an action relying on this CLI.

## Troubleshooting

#### Errors related to `docker-credential-osxkeychain` not found when running analysis

Install the docker credential helper. For example, in MacOS:

```bash
brew install docker-credential-helper
```