-
-
Notifications
You must be signed in to change notification settings - Fork 4.9k
code2prompt, yek: add page #19353
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.
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
Open
radheshpai87
wants to merge
8
commits into
tldr-pages:main
Choose a base branch
from
radheshpai87:docs/code2prompt-yek
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−0
Open
code2prompt, yek: add page #19353
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3f04ba1
docs: add Code2Prompt and Yek tldr pages (repomapper tools)
radheshpai87 38e94ab
docs: add Code2Prompt and Yek tldr pages (repomapper tools)
radheshpai87 8b72aba
Merge branch 'main' into docs/code2prompt-yek
radheshpai87 7bd1d0a
Merge branch 'main' into docs/code2prompt-yek
radheshpai87 d7d0247
Merge branch 'tldr-pages:main' into docs/code2prompt-yek
radheshpai87 17bd283
added requested changes
radheshpai87 cb41988
Merge branch 'main' into docs/code2prompt-yek
radheshpai87 f055076
added requested changes
radheshpai87 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # code2prompt | ||
|
|
||
| > Generate AI-ready prompts from a codebase (extracts, filters and formats code for LLMs). | ||
| > More information: <https://code2prompt.dev/docs/tutorials/getting_started/>. | ||
| - Generate a prompt for the current project and copy it to the clipboard (default behaviour): | ||
|
|
||
| `code2prompt {{path/to/project}}` | ||
|
|
||
| - Include only specific files and exclude a directory: | ||
|
|
||
| `code2prompt {{path/to/project}} --include "{{**/*.rs}}" --exclude "{{tests/**}}"` | ||
|
|
||
| - Write the prompt to a file instead of the clipboard: | ||
|
|
||
| `code2prompt {{path/to/project}} --output-file {{my_prompt.txt}}` | ||
|
|
||
| - Produce structured JSON output: | ||
|
|
||
| `code2prompt {{path/to/project}} --output-format {{json}}` | ||
|
|
||
| - Use a custom Handlebars template when generating the prompt: | ||
|
|
||
| `code2prompt {{path/to/project}} --template {{my_template.hbs}}` | ||
|
|
||
| - Run as an MCP server for dynamic agent integration (advanced): | ||
|
|
||
| `code2prompt server --port {{1234}}` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # yek | ||
|
|
||
| > Serialize a repository or directory into an LLM-friendly single file (fast Rust-based repomapper). | ||
| > More information: <https://github.com/bodo-run/yek#usage>. | ||
|
|
||
| - Serialize the current directory and write the output to a temp file (prints path): | ||
|
|
||
| `yek` | ||
|
|
||
| - Serialize specific directories and write output to a directory: | ||
|
|
||
| `yek {{path/to/directory path/to/directory2 ...}} --output-dir {{/tmp/yek}}` | ||
|
|
||
| - Process multiple files or use glob patterns (quote globs to avoid shell expansion): | ||
|
|
||
| `yek "{{path/to/directory/**/*.rs}}" "{{path/to/directory/**/*.md}}"` | ||
|
|
||
| - Cap the token-based output size to 128k tokens: | ||
|
|
||
| `yek {{path/to/directory}} --tokens 128k` | ||
|
|
||
| - Cap the byte-based max output size and set an explicit output file name: | ||
|
|
||
| `yek {{path/to/directory}} --max-size {{100KB}} --output-name {{yek-output.txt}}` | ||
|
|
||
| - Stream JSON output: | ||
|
|
||
| `yek {{path/to/directory}} --json` | ||
|
|
||
| - Include a directory tree header in the output: | ||
|
|
||
| `yek {{path/to/directory}} --tree-header` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still doesn't instruct on how to use the tool. I'll install it tomorrow to check what its help page says.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I even checked the github but all leads to this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dmmqz linked this https://code2prompt.dev/docs/how_to/filter_files/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But that only gives different flags for filtering files.