GoogleChromeLabs / ps-analysis-tool

Privacy Sandbox Analysis Chrome Extension and CLI for analysis and understanding of cookie usage on web pages, and new privacy-preserving Chrome APIs
https://www.privacysandbox.com
Apache License 2.0
97 stars 22 forks source link

Add link to the PSAT wiki on the CLI help message #743

Closed fellyph closed 2 months ago

fellyph commented 3 months ago

Feature Request

Description: On the help message, list all the options around the PSAT CLI. To complement that information, it will be good to add a link to the PSAT Wiki documentation.

now

> ps-analysis-tool@0.9.0 cli
> node packages/cli/dist/main.js --help

Usage: main [options] [website-url]

CLI to test a URL for 3p cookies.

Arguments:
  website-url                 The URL of a single site to analyze

Options:
  -V, --version               output the version number
  -u, --url <url>             The URL of a single site to analyze
  -s, --source-url <url>       The URL of a sitemap or CSV to analyze
  -f, --file <path>           The path to a local file (CSV or XML sitemap) to analyze
  -n, --number-of-urls <num>  Limit the number of URLs to analyze (from sitemap or CSV)
  -d, --display               Flag for running CLI in non-headless mode
  -v, --verbose               Enables verbose logging
  -t, --tech                  Enables technology analysis
  -o, --out-dir <path>        Directory to store analysis data (JSON, CSV, HTML) without launching the dashboard
  -i, --ignore-gdpr           Ignore automatically accepting the GDPR banner if present
  -q, --quiet                 Skips all prompts; uses default options
  -c, --concurrency <num>     Number of tabs to open in parallel during sitemap or CSV analysis (default: 3)
  -w, --wait <num>            Number of seconds to wait after the page is loaded before generating the report
                              (default: 20000)
  -l, --locale <language>     Locale to use for the CLI, supported: en, hi, es, ja, ko, pt-BR (default: "en")
  -h, --help                  display help for command

Adding a link to the bottom:

> node packages/cli/dist/main.js --help

Usage: main [options] [website-url]

CLI to test a URL for 3p cookies.

Arguments:
  website-url                 The URL of a single site to analyze

Options:
  -V, --version               output the version number
  -u, --url <url>             The URL of a single site to analyze
  -s, --source-url <url>       The URL of a sitemap or CSV to analyze
  -f, --file <path>           The path to a local file (CSV or XML sitemap) to analyze
  -n, --number-of-urls <num>  Limit the number of URLs to analyze (from sitemap or CSV)
  -d, --display               Flag for running CLI in non-headless mode
  -v, --verbose               Enables verbose logging
  -t, --tech                  Enables technology analysis
  -o, --out-dir <path>        Directory to store analysis data (JSON, CSV, HTML) without launching the dashboard
  -i, --ignore-gdpr           Ignore automatically accepting the GDPR banner if present
  -q, --quiet                 Skips all prompts; uses default options
  -c, --concurrency <num>     Number of tabs to open in parallel during sitemap or CSV analysis (default: 3)
  -w, --wait <num>            Number of seconds to wait after the page is loaded before generating the report
                              (default: 20000)
  -l, --locale <language>     Locale to use for the CLI, supported: en, hi, es, ja, ko, pt-BR (default: "en")
  -h, --help                  display help for command

To learn more, visit our wiki: https://github.com/GoogleChromeLabs/ps-analysis-tool/wiki.

Motivation: This URL can guide users in reading more about the project and finding relevant information about the audit process.

User Story: As a user, I want to learn more about PSAT to take advantage of all PSAT features.

Acceptance Criteria:

Additional Information: [Include any additional information or context that may be helpful, such as related resources or examples.]

fellyph commented 2 months ago

This item was included in version 0.10:

Screenshot 2024-08-02 at 09 23 27

This feature request can be closed.

maitreyie-chavan commented 2 months ago

Addressed and released as a part of v0.10