Skip to content

Commit 1bd543b

Browse files
docs: add include_submodules example in README.md
1 parent 8575f47 commit 1bd543b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,9 @@ gitingest https://github.com/username/private-repo --token github_pat_...
122122
# Or set it as an environment variable
123123
export GITHUB_TOKEN=github_pat_...
124124
gitingest https://github.com/username/private-repo
125+
126+
# Include repository submodules
127+
gitingest https://github.com/username/repo-with-submodules --include-submodules
125128
```
126129

127130
By default, files listed in `.gitignore` are skipped. Use `--include-gitignored` if you
@@ -163,6 +166,9 @@ summary, tree, content = ingest("https://github.com/username/private-repo", toke
163166
import os
164167
os.environ["GITHUB_TOKEN"] = "github_pat_..."
165168
summary, tree, content = ingest("https://github.com/username/private-repo")
169+
170+
# Include repository submodules
171+
summary, tree, content = ingest("https://github.com/username/repo-with-submodules", include_submodules=True)
166172
```
167173

168174
By default, this won't write a file but can be enabled with the `output` argument.

0 commit comments

Comments
 (0)