chore: update contributing docs with latest uv setup#2479
Open
yosefAlsuhaibani wants to merge 2 commits intomainfrom
Open
chore: update contributing docs with latest uv setup#2479yosefAlsuhaibani wants to merge 2 commits intomainfrom
yosefAlsuhaibani wants to merge 2 commits intomainfrom
Conversation
✅ Deploy Preview for semgrep-docs-prod ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
khorne3
approved these changes
Jan 30, 2026
| ``` | ||
|
|
||
| Next, initialize and enter the virtual environment. The following command installs developer dependencies, such as `pytest`, and installs `semgrep` in editable mode in the virtual environment. From the `cli` directory, run the following command: | ||
| Next, initialize the virtual environment. The following commands installs both the required dependencies and the developer dependencies, such as `pytest`, and installs `semgrep` in editable mode in the virtual environment. From the `cli` directory, run the following command: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Next, initialize the virtual environment. The following commands installs both the required dependencies and the developer dependencies, such as `pytest`, and installs `semgrep` in editable mode in the virtual environment. From the `cli` directory, run the following command: | |
| Next, initialize the virtual environment. The following commands install both the required dependencies and the developer dependencies, such as `pytest`, and install `semgrep` in editable mode in the virtual environment. From the `cli` directory, run the following command: |
| By convention, your shell prompt is prepended with `(cli)` when the virtual environment is active. | ||
|
|
||
| Next, install the Python dependencies: | ||
| To execute `semgrep` in this virtual environiment, you could activate the virtual environment as follows: |
Collaborator
There was a problem hiding this comment.
Suggested change
| To execute `semgrep` in this virtual environiment, you could activate the virtual environment as follows: | |
| To execute `semgrep` in the virtual environment, activate the virtual environment as follows: |
| ## Run `semgrep-cli` | ||
|
|
||
| Ensure that you are in the `cli/` directory, and then issue the following command: | ||
| Ensure that you are in the `cli/` directory and that you have activated the virtual environment with the installed wheel, then issue the following command: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Ensure that you are in the `cli/` directory and that you have activated the virtual environment with the installed wheel, then issue the following command: | |
| Ensure that you are in the `cli/` directory and that you have activated the virtual environment with the installed wheel. Then, run the following command: |
Contributor
|
Proposal: this should wait on https://github.com/semgrep/semgrep-proprietary/pull/5516 being approved, for any requested changes in that PR. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Thanks for improving Semgrep Docs 😀
Please ensure
Adding a new documentation page? Click to expand the checklist
.mdor.mdxfile in/docs/[section]/with frontmatter:slug,title,description,displayed_sidebar,tags/sidebars.js(shows in side nav)/src/theme/Navbar/Content/index.tsx→ add path togetCurrentSection()(highlights top nav)Sidebars fields for
displayed_sidebar:scanSidebar|rulewritingSidebar|devSidebar|learnSidebar|aboutSidebar|kbSidebar|whatsSemgrepSidebarTop nav fields for
getCurrentSection():'scan'|'write-rules'|'learning-guides'|'help'|'explore'