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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix typo in analyze-namespace option in the README #52

Merged
merged 1 commit into from
Nov 25, 2022

Conversation

parroty
Copy link
Contributor

@parroty parroty commented Nov 25, 2022

What's being changed?

Hi 馃憢 . This PR just intends to fix the example description for --namespace option. I believe the option name is singular, though it can take multiple items.

from execution

$ legitify analyze --org sample-org-1 --namespaces organization,member

 ___      _______  _______  ___   _______  ___   _______  __   __
|   |    |       ||       ||   | |       ||   | |       ||  | |  |
|   |    |    ___||    ___||   | |_     _||   | |    ___||  |_|  |
|   |    |   |___ |   | __ |   |   |   |  |   | |   |___ |       |
|   |___ |    ___||   ||  ||   |   |   |  |   | |    ___||_     _|
|       ||   |___ |   |_| ||   |   |   |  |   | |   |      |   |
|_______||_______||_______||___|   |___|  |___| |___|      |___|
By Legit Security

Error: unknown flag: --namespaces
2022/11/24 20:17:06 error executing command: unknown flag: --namespaces

from help

$ legitify analyze --help
 ___      _______  _______  ___   _______  ___   _______  __   __
|   |    |       ||       ||   | |       ||   | |       ||  | |  |
|   |    |    ___||    ___||   | |_     _||   | |    ___||  |_|  |
|   |    |   |___ |   | __ |   |   |   |  |   | |   |___ |       |
|   |___ |    ___||   ||  ||   |   |   |  |   | |    ___||_     _|
|       ||   |___ |   |_| ||   |   |   |  |   | |   |      |   |
|_______||_______||_______||___|   |___|  |___| |___|      |___|
By Legit Security

Analyze GitHub organizations associated with a PAT to find security issues

Usage:
  legitify analyze [flags]

Flags:
      --color string            when to use coloring [auto/always/none] (default "auto")
      --error-file string       error log path (default "error.log")
      --failed-only             Only show violated policied (do not show succeeded/skipped)
  -t, --github-token string     token to authenticate with github (required unless environment variable GITHUB_TOKEN is set)
  -h, --help                    help for analyze
  -n, --namespace strings       which namespace to run (default [organization,repository,member,actions])
      --org strings             specific organizations to collect
      --output-file string      output file, defaults to stdout
  -f, --output-format string    output format [json/human] (default "human")
      --output-scheme string    output scheme [group-by-resource/group-by-severity/flattened/group-by-namespace] (default "flattened")
  -p, --policies-path strings   directory containing opa policies
      --repo strings            specific repositories to collect (--repo owner/repo_name (e.g. ossf/scorecard)
      --scorecard string        Whether to run additional scorecard checks [no/yes/verbose] (default "no")

Is this PR related to an existing issue?

Check off the following:

  • This PR follows the CONTRIBUTION.md guidelines
  • I have self-reviewed my changes before submitting the PR

@parroty parroty requested a review from a team as a code owner November 25, 2022 01:42
@noamd-legit
Copy link
Contributor

@parroty You're right! Merging

@noamd-legit noamd-legit merged commit 13d5bb2 into Legit-Labs:main Nov 25, 2022
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

Successfully merging this pull request may close these issues.

None yet

2 participants