Skip to content

Commit 05e74c4

Browse files
authored
Document --progress-bar in README (#272)
1 parent d56d117 commit 05e74c4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Diff for: README.md

+8
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,14 @@ src lsif upload -github-token='${{ secrets.GITHUB_TOKEN }}' -no-progress
6868
For more examples, see the
6969
[Sourcegraph docs](https://docs.sourcegraph.com/code_intelligence/how-to/index_a_typescript_and_javascript_repository).
7070

71+
### Troubleshooting stalled progress
72+
73+
If `scip-typescript index` is not showing progress, try running it again with
74+
the `--progress-bar` flag. The progress bar prints out the current file being
75+
indexed that could reveal details why progress is stalling. The progress bar
76+
is disabled by default because it prints out a lot of noise in CI logs, and
77+
the most common environment to run scip-typescript is in CI.
78+
7179
### Dealing with out of memory issues (OOM)
7280

7381
You may experience OOM issues when indexing large codebases

0 commit comments

Comments
 (0)