From f5e9204b54c339ccd9dedb1077c59b78a32ada98 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 5 Feb 2025 04:46:55 +0000 Subject: [PATCH] Updated help command output based on latest Semgrep release --- .../reference/_cli-help-ci-output.md | 134 ++---------------- src/components/reference/_cli-help-output.md | 32 ++--- .../reference/_cli-help-scan-output.md | 2 +- 3 files changed, 25 insertions(+), 143 deletions(-) diff --git a/src/components/reference/_cli-help-ci-output.md b/src/components/reference/_cli-help-ci-output.md index 4f3cf1f11..513ef1845 100644 --- a/src/components/reference/_cli-help-ci-output.md +++ b/src/components/reference/_cli-help-ci-output.md @@ -127,44 +127,6 @@ OPTIONS Always include ANSI color in the output, even if not writing to a TTY; defaults to using the TTY status - --gh-token=VAL (absent GH_TOKEN env) - The GitHub token. - - --github-api-url=VAL (absent GITHUB_API_URL env) - The GitHub API URL. - - --github-event-name=VAL (absent GITHUB_EVENT_NAME env) - The GitHub event name. - - --github-event-path=VAL (absent GITHUB_EVENT_PATH env) - The GitHub event path. - - --github-head-ref=VAL (absent GITHUB_HEAD_REF env) - The GitHub HEAD ref. - - --github-ref=VAL (absent GITHUB_REF env) - The GitHub ref. - - --github-repository=VAL (absent GITHUB_REPOSITORY env) - The GitHub repository. - - --github-repository-id=VAL (absent GITHUB_REPOSITORY_ID env) - The ID of the repository. - - --github-repository-owner-id=VAL (absent GITHUB_REPOSITORY_OWNER_ID - env) - The repository owner's account ID. - - --github-run-id=VAL (absent GITHUB_RUN_ID env) - The GitHub run ID. - - --github-server-url=VAL (absent=https://github.com or - GITHUB_SERVER_URL env) - The GitHub server URL. - - --github-sha=VAL (absent GITHUB_SHA env) - The GitHub commit. - --gitlab-sast Output results in GitLab SAST format. @@ -208,7 +170,7 @@ OPTIONS it defaults to 3 hours. --internal-ci-scan-results - + Internal flag. -j VAL, --jobs=VAL (absent=4) Number of subprocesses to use to run checks in parallel. Defaults @@ -355,32 +317,6 @@ OPTIONS validation. Requires access to Secrets, contact support@semgrep.com for more information. - --semgrep-branch=VAL (absent SEMGREP_BRANCH env) - The Git branch. - - --semgrep-commit=VAL (absent SEMGREP_COMMIT env) - The commit of the Git repository. - - --semgrep-job-url=VAL (absent SEMGREP_JOB_URL env) - The job URL. - - --semgrep-pr-id=VAL (absent SEMGREP_PR_ID env) - The PR/MR ID. - - --semgrep-pr-title=VAL (absent SEMGREP_PR_TITLE env) - The PR/MR title. - - --semgrep-repo-display-name=VAL (absent SEMGREP_REPO_DISPLAY_NAME env) - The name the repository should be displayed as for this scan. - Setting it allows users to scan individual repos in one monorepo - separately. - - --semgrep-repo-name=VAL (absent SEMGREP_REPO_NAME env) - The name of the Git repository. - - --semgrep-repo-url=VAL (absent SEMGREP_REPO_URL env) - The URL of the Git repository. - --skip-unknown-extensions negates --scan-unknown-extensions @@ -423,7 +359,7 @@ OPTIONS Endpoint to send OpenTelemetry traces to, if `--trace` is present. The value may be `semgrep-prod` (default), `semgrep-dev`, `semgrep-local`, or any valid URL. This feature is meant for - internal use and may be changed or removed wihtout warning. + internal use and may be changed or removed without warning. --use-git-ignore '--no-git-ignore' causes semgrep to not call 'git' and not consult @@ -467,6 +403,12 @@ OPTIONS --x-partial-output=VAL Internal flag. + --x-upload-partial-results=VAL + Internal flag. + + --x-upload-partial-results-scan-id=VAL + Internal flag. + --x-validate-partial-results-actual=VAL Internal flag. @@ -493,81 +435,21 @@ EXIT STATUS ENVIRONMENT These environment variables affect the execution of semgrep ci: - GH_TOKEN - See option --gh-token. - - GITHUB_API_URL - See option --github-api-url. - - GITHUB_EVENT_NAME - See option --github-event-name. - - GITHUB_EVENT_PATH - See option --github-event-path. - - GITHUB_HEAD_REF - See option --github-head-ref. - - GITHUB_REF - See option --github-ref. - - GITHUB_REPOSITORY - See option --github-repository. - - GITHUB_REPOSITORY_ID - See option --github-repository-id. - - GITHUB_REPOSITORY_OWNER_ID - See option --github-repository-owner-id. - - GITHUB_RUN_ID - See option --github-run-id. - - GITHUB_SERVER_URL - See option --github-server-url. - - GITHUB_SHA - See option --github-sha. - SEMGREP_AUDIT_ON See option --audit-on. SEMGREP_BASELINE_COMMIT See option --baseline-commit. - SEMGREP_BRANCH - See option --semgrep-branch. - - SEMGREP_COMMIT - See option --semgrep-commit. - SEMGREP_ENABLE_VERSION_CHECK See option --enable-version-check. SEMGREP_FORCE_COLOR See option --force-color. - SEMGREP_JOB_URL - See option --semgrep-job-url. - SEMGREP_OTEL_ENDPOINT See option --trace-endpoint. - SEMGREP_PR_ID - See option --semgrep-pr-id. - - SEMGREP_PR_TITLE - See option --semgrep-pr-title. - - SEMGREP_REPO_DISPLAY_NAME - See option --semgrep-repo-display-name. - - SEMGREP_REPO_NAME - See option --semgrep-repo-name. - - SEMGREP_REPO_URL - See option --semgrep-repo-url. - SEMGREP_SEND_METRICS See option --metrics. diff --git a/src/components/reference/_cli-help-output.md b/src/components/reference/_cli-help-output.md index 6000cbe36..38cad32d9 100644 --- a/src/components/reference/_cli-help-output.md +++ b/src/components/reference/_cli-help-output.md @@ -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) ``` diff --git a/src/components/reference/_cli-help-scan-output.md b/src/components/reference/_cli-help-scan-output.md index d46927490..c0b5b9c61 100644 --- a/src/components/reference/_cli-help-scan-output.md +++ b/src/components/reference/_cli-help-scan-output.md @@ -433,7 +433,7 @@ OPTIONS Endpoint to send OpenTelemetry traces to, if `--trace` is present. The value may be `semgrep-prod` (default), `semgrep-dev`, `semgrep-local`, or any valid URL. This feature is meant for - internal use and may be changed or removed wihtout warning. + internal use and may be changed or removed without warning. --use-git-ignore '--no-git-ignore' causes semgrep to not call 'git' and not consult