Skip to content
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

Update help command output for Semgrep 1.103.0 #1907

Merged
merged 2 commits into from
Jan 23, 2025
Merged
Changes from 1 commit
Commits
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
Next Next commit
Updated help command output based on latest Semgrep release
github-actions committed Jan 15, 2025
commit eeb4d3796f018489f52e3b5d3b5439a0525f2130
2 changes: 1 addition & 1 deletion src/components/reference/_cli-help-ci-output.md
Original file line number Diff line number Diff line change
@@ -378,7 +378,7 @@ OPTIONS
--skip-unknown-extensions
negates --scan-unknown-extensions

--subdir=VAL (absent=/src)
--subdir=VAL
Scan only a subdirectory of this folder. This creates a project
specific to the subdirectory unless SEMGREP_REPO_DISPLAY_NAME is
set. Expects a relative path. (Note that when two scans have the
32 changes: 16 additions & 16 deletions src/components/reference/_cli-help-output.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
```
Usage: semgrep [OPTIONS] COMMAND [ARGS]...
Usage: semgrep [OPTIONS] COMMAND [ARGS]...

To get started quickly, run `semgrep scan --config auto`
To get started quickly, run `semgrep scan --config auto`

Run `semgrep SUBCOMMAND --help` for more information on each subcommand
Run `semgrep SUBCOMMAND --help` for more information on each subcommand

If no subcommand is passed, will run `scan` subcommand by default
If no subcommand is passed, will run `scan` subcommand by default

Options:
Options:
-h, --help Show this message and exit.

Commands:
ci Run Semgrep on a git diff (for use in CI)
install-semgrep-pro Install the Semgrep Pro Engine
login Obtain and save credentials for semgrep.dev
logout Remove locally stored credentials to semgrep.dev
lsp Start the Semgrep LSP server (useful for IDEs)
publish Upload rule to semgrep.dev
scan Run Semgrep rules on local folders or files
show Show various types of information
test Test the rules
validate Validate the rules
Commands:
ci Run Semgrep on a git diff (for use in CI)
install-semgrep-pro Install the Semgrep Pro Engine
login Obtain and save credentials for semgrep.dev
logout Remove locally stored credentials to semgrep.dev
lsp Start the Semgrep LSP server (useful for IDEs)
publish Upload rule to semgrep.dev
scan Run Semgrep rules on local folders or files
show Show various types of information
test Test the rules (EXPERIMENTAL improvements over scan --test)
validate Validate the rules (EXPERIMENTAL improvements over scan --validate)
```