Skip to content

Add subdirectory URL syntax documentation to README #254

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
merged 3 commits into from
Jun 21, 2025
Merged

Add subdirectory URL syntax documentation to README #254

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ec39fd
Add subdirectory URL syntax documentation to README
pokey Apr 5, 2025
372d4e9
Merge branch 'main' into pokey/add-subdirectory-url-syntax-documentat…
filipchristiansen Jun 21, 2025
60aa6af
Update README.md
filipchristiansen Jun 21, 2025
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ gitingest /path/to/directory

# From URL
gitingest https://github.com/cyclotruc/gitingest

# or from specific subdirectory
gitingest https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils
```

For private repositories, use the `--token/-t` option.
Expand Down Expand Up @@ -117,6 +120,9 @@ summary, tree, content = ingest("path/to/directory")

# or from URL
summary, tree, content = ingest("https://github.com/cyclotruc/gitingest")

# or from a specific subdirectory
summary, tree, content = ingest("https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils")
```

For private repositories, you can pass a token:
Expand Down
Loading