usage: gftools-qa [-h] (-f FONTS [FONTS ...] | -pr PULL_REQUEST | -gh GITHUB_DIR |
-gf GOOGLEFONTS | -ar ARCHIVE) [-fb FONTS_BEFORE [FONTS_BEFORE ...] |
-prb PULL_REQUEST_BEFORE | -ghb GITHUB_DIR_BEFORE | -arb ARCHIVE_BEFORE | -gfb]
[-a] [--diffenator] [--proof] [--render] [--fontspector] [--diffbrowsers]
[--interpolations] [-re FILTER_FONTS] [-o OUT] [-ogh] [--out-url OUT_URL]
[--rust] [--extra-fontspector-args EXTRA_FONTSPECTOR_ARGS] [--imgs] [--version]
Check a font family using Google Fonts QA tools.
Examples:
Check a local family against the same family hosted on Google Fonts:
`gftools qa -f [fonts.ttf] -gfb -a -o qa`
Check a local family against another local family and generate reports
for Font Diffenator only:
`gftools qa -f [fonts_a.ttf] -fb [fonts_b.ttf] --diffenator -o qa`
Compare a pull request against the same family hosted on Google Fonts:
`gftools qa -pr www.github.com/user/repo/pull/1 -gfb -a -o qa`
Compare a github folder of fonts against the same family hosted on Google
Fonts:
`gftools qa -gh www.github.com/user/repo/tree/fonts/ttf -gfb -a -o qa`
options:
-h, --help show this help message and exit
-re, --filter-fonts FILTER_FONTS
Filter fonts by regex
-o, --out OUT Output path for check results
-ogh, --out-github Post report data to either the pull request as a comment open a new issue.
This can only be used if fonts have been fetched from either a pull
request or github dir.
--out-url OUT_URL Post report data to a github pr. This can be used with any font fetching
method.
--rust Use Rust tooling
--imgs Gen images using Selenium
--version show program's version number and exit
Fonts to qa:
-f, --fonts FONTS [FONTS ...]
Paths to fonts
-pr, --pull-request PULL_REQUEST
Get fonts from a Github pull request
-gh, --github-dir GITHUB_DIR
Get fonts from a Github directory
-gf, --googlefonts GOOGLEFONTS
Get fonts from Google Fonts
-ar, --archive ARCHIVE
Get fonts from a zip file URL
Fonts before input:
-fb, --fonts-before FONTS_BEFORE [FONTS_BEFORE ...]
Paths to previous fonts
-prb, --pull-request-before PULL_REQUEST_BEFORE
Get previous fonts from a Github pull request
-ghb, --github-dir-before GITHUB_DIR_BEFORE
Get previous fonts from a Github dir
-arb, --archive-before ARCHIVE_BEFORE
Get previous fonts from a zip file URL
-gfb, --googlefonts-before
Get previous fonts from Google Fonts
QA checks:
-a, --auto-qa Check fonts against against the same fonts hosted on Google Fonts
--diffenator Run Fontdiffenator
--proof Run HTML proofs
--render Run diffbrowsers if fonts_before exist, otherwise run proof
--fontspector Run FontBakery
--diffbrowsers Run Diffbrowsers
--interpolations Run interpolation checker
--extra-fontspector-args EXTRA_FONTSPECTOR_ARGS
Additional arguments to Fontspector
Options (24)
| Option | Description | Source |
|---|
-h, --help | show this help message and exit | help |
-re, --filter-fonts FILTER_FONTS | Filter fonts by regex | help |
-o, --out OUT | Output path for check results | help |
-ogh, --out-github | Post report data to either the pull request as a comment open a new issue. | help |
--out-url OUT_URL | Post report data to a github pr. | help |
--rust | Use Rust tooling | help |
--imgs | Gen images using Selenium | help |
--version | show program's version number and exit | help |
-pr, --pull-request PULL_REQUEST | Get fonts from a Github pull request | help |
-gh, --github-dir GITHUB_DIR | Get fonts from a Github directory | help |
-gf, --googlefonts GOOGLEFONTS | Get fonts from Google Fonts | help |
-ar, --archive ARCHIVE | Get fonts from a zip file URL | help |
-prb, --pull-request-before PULL_REQUEST_BEFORE | Get previous fonts from a Github pull request | help |
-ghb, --github-dir-before GITHUB_DIR_BEFORE | Get previous fonts from a Github dir | help |
-arb, --archive-before ARCHIVE_BEFORE | Get previous fonts from a zip file URL | help |
-gfb, --googlefonts-before | Get previous fonts from Google Fonts | help |
-a, --auto-qa | Check fonts against against the same fonts hosted on Google Fonts | help |
--diffenator | Run Fontdiffenator | help |
--proof | Run HTML proofs | help |
--render | Run diffbrowsers if fonts_before exist, otherwise run proof | help |
--fontspector | Run FontBakery | help |
--diffbrowsers | Run Diffbrowsers | help |
--interpolations | Run interpolation checker | help |
--extra-fontspector-args EXTRA_FONTSPECTOR_ARGS | Additional arguments to Fontspector | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.