Skip to content

Commit

Permalink
Document --progress-bar in README (#272)
Browse files Browse the repository at this point in the history
  • Loading branch information
olafurpg authored Jul 11, 2023
1 parent d56d117 commit 05e74c4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,14 @@ src lsif upload -github-token='${{ secrets.GITHUB_TOKEN }}' -no-progress
For more examples, see the
[Sourcegraph docs](https://docs.sourcegraph.com/code_intelligence/how-to/index_a_typescript_and_javascript_repository).

### Troubleshooting stalled progress

If `scip-typescript index` is not showing progress, try running it again with
the `--progress-bar` flag. The progress bar prints out the current file being
indexed that could reveal details why progress is stalling. The progress bar
is disabled by default because it prints out a lot of noise in CI logs, and
the most common environment to run scip-typescript is in CI.

### Dealing with out of memory issues (OOM)

You may experience OOM issues when indexing large codebases
Expand Down

0 comments on commit 05e74c4

Please sign in to comment.