doc: update scan/new/test options

HerringtonDarkholme · HerringtonDarkholme · commit e6be881260bd · 2024-11-01T01:18:51.000-04:00
diff --git a/website/reference/cli.md b/website/reference/cli.md
@@ -74,6 +74,17 @@ sg scan [OPTIONS] [PATHS]...
 |   |  --stdin           | Enable search code from StdIn. See [link](/guide/tooling-overview.html#enable-stdin-mode) |
 |   | --globs `<GLOBS>`   | Include or exclude file paths
 |   |  --tracing `<LEVEL>`  | Show tracing information for file/rule discovery and scanning [default: nothing] [possible values: nothing, summary]
+|   | --error`[=<RULE_ID>...]`| Set rule severity to error
+|   | --warning`[=<RULE_ID>...]`| Set rule severity to warning
+|   | --info`[=<RULE_ID>...]`| Set rule severity to info
+|   | --hint`[=<RULE_ID>...]`| Set rule severity to hint
+|   | --off`[=<RULE_ID>...]`| Turn off the rule
+|   | --after `<NUM>`      | Show NUM lines after each match [default: 0] |
+|   | --before `<NUM>`     | Show NUM lines before each match [default: 0] |
+|   | --context `<NUM>`    | Show NUM lines around each match [default: 0] |
+| -A| --after `<NUM>`      | Show NUM lines after each match [default: 0] |
+| -B| --before `<NUM>`     | Show NUM lines before each match [default: 0] |
+| -C| --context `<NUM>`    | Show NUM lines around each match [default: 0] |
 | -h| --help|Print help|
 
 ## `sg test`
diff --git a/website/reference/cli/new.md b/website/reference/cli/new.md
@@ -72,10 +72,8 @@ Accept all default options without interactive input during creation.
 
 You need to provide all required arguments via command line if this flag is true. Please see the command description for the what arguments are required.
 
-### `-b, --base-dir <BASE_DIR>`
-Create new project/items in the folder specified by this argument
-
-[default: .]
+### `-c, --config <CONFIG_FILE>`
+Path to ast-grep root config, default is sgconfig.yml
 
 ### `-h, --help`
 Print help (see a summary with '-h')
diff --git a/website/reference/cli/scan.md b/website/reference/cli/scan.md
@@ -121,6 +121,29 @@ Currently, only GitHub is supported.
 
 [possible values: github]
 
+## Context Options
+
+### `-A, --after <NUM>`
+Show NUM lines after each match.
+
+It conflicts with both the -C/--context flag.
+
+[default: 0]
+
+### `-B, --before <NUM>`
+Show NUM lines before each match.
+
+It conflicts with both the -C/--context flag.
+
+[default: 0]
+
+### `-C, --context <NUM>`
+Show NUM lines around each match.
+
+This is equivalent to providing both the -B/--before and -A/--after flags with the same value. It conflicts with both the -B/--before and -A/--after flags.
+
+[default: 0]
+
 ## Style Options
 
 ### `--color <WHEN>`
@@ -144,5 +167,34 @@ Possible values:
 - medium: Output a condensed diagnostic, with a line number, severity, message and notes (if any)
 - short:  Output a short diagnostic, with a line number, severity, and message
 
+## Rule Options
+
+These rule option flags set the specified RULE_ID's severity to a specific level. You can specify multiple rules by using the flag multiple times, e.g., `--error=RULE_1 --error=RULE_2`. If no RULE_ID is provided, all rules will be set to the specified level, e.g., `--error`. Note, these flags must use `=` to specify its value.
+
+### `--error[=<RULE_ID>...]`
+Set rule severity to error
+
+This flag sets the specified RULE_ID's severity to error. You can specify multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be set to error. Note, this flag must use `=` to specify its value.
+
+### `--warning[=<RULE_ID>...]`
+Set rule severity to warning
+
+This flag sets the specified RULE_ID's severity to warning. You can specify multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be set to warning. Note, this flag must use `=` to specify its value.
+
+### `--info[=<RULE_ID>...]`
+Set rule severity to info
+
+This flag sets the specified RULE_ID's severity to info. You can specify multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be set to info. Note, this flag must use `=` to specify its value.
+
+### `--hint[=<RULE_ID>...]`
+Set rule severity to hint
+
+This flag sets the specified RULE_ID's severity to hint. You can specify multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be set to hint. Note, this flag must use `=` to specify its value.
+
+### `--off[=<RULE_ID>...]`
+Turn off rule
+
+This flag turns off the specified RULE_ID. You can disable multiple rules by using the flag multiple times. If no RULE_ID is provided, all rules will be turned off. Note, this flag must use `=` to specify its value.
+
 ### `-h, --help`
   Print help (see a summary with '-h')
diff --git a/website/reference/cli/test.md b/website/reference/cli/test.md
@@ -15,8 +15,7 @@ sg test [OPTIONS]
 ## Options
 
 ### `-c, --config <CONFIG>`
-
-Path to the root ast-grep config YAML
+Path to ast-grep root config, default is sgconfig.yml
 
 ### `-t, --test-dir <TEST_DIR>`
 
