Skip to content

Commit

Permalink
docs(site): document new command-line options for the scan command.
Browse files Browse the repository at this point in the history
Add documentation for `--print-meta`, `--print-tags` and `--tag`.
  • Loading branch information
plusvic committed Aug 5, 2024
1 parent 0ee4100 commit 730e033
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions site/content/docs/intro/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,14 +148,6 @@ run:
yr scan --output-format ndjson rules/test.yara /bin | jq .path
```

### --print-strings, -s

Prints the matching patterns or strings.

### --print-namespace, -e

Prints the namespace of matching rules.

### --path-as-namespace

Use the path of each YARA source file as its namespace.
Expand All @@ -166,6 +158,22 @@ same namespace, YARA is going to complain about the duplicated rule identifiers.
However, if every file is put under its own namespace the rule names won't
collide.

### --print-meta, -m

Prints the metadata associated to matching rules.

### --print-namespace, -e

Prints the namespace of matching rules.

### --print-strings, -s

Prints the matching patterns or strings.

### --print-tags, -g

Print the tags associated to matching rules.

### --relaxed-re-syntax

Use a more relaxed syntax check while parsing regular expressions.
Expand All @@ -191,6 +199,10 @@ must be either absolute paths, or relative to the current directory.

Skips files larger than the given size in bytes.

### --tag <TAG>, -t <TAG>

Print only the matching rules that have the given tag.

### --threads, -p <NUM_THREADS>

Use the specified number of threads. By default, it uses as many threads as
Expand Down

0 comments on commit 730e033

Please sign in to comment.