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

Minor issues with: sarif-sdk/docs /multitool-usage.md file #2850

Open
davewichers opened this issue Jan 20, 2025 · 0 comments
Open

Minor issues with: sarif-sdk/docs /multitool-usage.md file #2850

davewichers opened this issue Jan 20, 2025 · 0 comments

Comments

@davewichers
Copy link

This file currently begins with the following:

: Install the current Sarif.Multitool to the local machine cache (requires Node.js)
npm i -g @microsoft/sarif-multitool

: Run the Sarif.Multitool using the NPM-installed copy
npx @microsoft/sarif-multitool <args>

: See Usage
Sarif.Multitool @microsoft/sarif-multitool help

: Convert a Fortify file to SARIF
Sarif.Multitool convert Current.fpr -tool FortifyFpr -output Current.sarif
  1. The last line shown above has a bug, because the parameters need to have TWO - in front of them, not one. i.e., --tool and --output

  2. Also, the 2nd block says you run Sarif.Multitool using the command: npx @microsoft/sarif-multitool <args>, and yet all the examples below that line use simply: Sarif.Multitool <args>, which I don't believe works.

Shouldn't all the examples below show the commands as: npx @microsoft/sarif-multitool <args>, not Sarif.Multitool <args>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant