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.

Sign up for GitHub

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

Jump to bottom

docs: add defaults to report docs #437

Merged
merged 1 commit into from Jan 23, 2023
Merged

docs: add defaults to report docs #437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/explanations/reports.md
View file
Open in desktop
Expand Up @@ -46,7 +46,7 @@ LOW: 0

Policy reports are [currently available](/reference/supported-languages/) for Ruby projects, with Javascript/Typescript coming soon and more languages to follow.

To run your first policy report, run `curio scan` with the `--report policies` flag.
To run your first policy report, run `curio scan .` on your project directory. By default, the policy report is output in a human-readable format, but you can also output it as YAML or JSON by using the `--format yaml` or `--format json` flags.

## Data Flow Report

Expand Down Expand Up @@ -117,7 +117,7 @@ If we look at the `db/schema.rb` file mentioned in the report, we can see that e
end
```

To run your first data flow report, run `curio scan` with the `--report dataflow` flag.
To run your first data flow report, run `curio scan` with the `--report dataflow` flag. By default, the data flow report is output in JSON format. To format as YAML, use the `--format yaml` flag.

## Stats Report

Expand Down Expand Up @@ -159,10 +159,10 @@ Scanning target... 100% [========================================] (278/278, 103

This report is useful for putting together ongoing statistics, making a quick check of data processing, or building internal dashboards. For more detailed information, you'll want to run a data flow report.

To run your first policy report, run `curio scan` with the `--report stats` flag.
To run your first stats report, run `curio scan` with the `--report stats` flag. By default, the stats report is output in JSON format. To format as YAML, use the `--format yaml` flag.

## Detectors Report

The detectors report type is the most low-level, data-rich type. You’re unlikely to use this report on its own, but it can be useful for building your own tooling based on the data parsed by Curio.

To run your first detectors report, run `curio scan` with the `--report detectors` flag.
To run your first detectors report, run `curio scan` with the `--report detectors` flag. By default, the detectors report is output in JSON format. To format as YAML, use the `--format yaml` flag.