@fukamo/cli

Audit a page with Fukamo from a terminal — the full audit, the same result a visitor gets on the website.

export FUKAMO_API_KEY=…            # never pass the key as a flag: argv is world-readable
npx @fukamo/cli audit https://example.com
npx @fukamo/cli audit https://example.com --query "seo audit"
npx @fukamo/cli audit https://example.com --json
npx @fukamo/cli audit https://example.com --pdf report.pdf
npx @fukamo/cli audit https://example.com --locale sk --pdf report.pdf   # the report in Slovak
npx @fukamo/cli result <id> --pdf report.pdf   # an audit already started, by its id

A full audit — the page scan plus Lighthouse (mobile and desktop), network checks and a rendered JavaScript check — takes a few minutes. The server queues it; the CLI waits and prints progress to stderr, then the result. The audit id is printed as soon as the audit is queued: if anything fails after that — a PDF refused, the network gone, Ctrl-C — fukamo result <id> picks the finished audit up without running (and paying for) it again.

--query is the search phrase the page should rank for. Without it Fukamo uses the first keyword it suggests for the page, as the website does; when a page offers none, the query checks are not measured.

--locale is the report's language — en (default), sk or es — for the printed findings, the --json answer and the PDF alike. result <id> keeps the language the audit was started in.

Exit code is 2 when the page has failing checks, 0 when it does not, 1 when the call failed — so fukamo audit "$URL" && deploy means something in CI.

--pdf writes the report, the same document a visitor downloads. Reports are charged apart from audits, fifteen an hour by default. Without a filename the file is named after the host. With --pdf the exit code is 0 once the file is written, whatever the page scored — the findings are in the file; use --json when CI should gate on them. --pdf works with audit only, one page at a time.

A full audit costs five of the key's sixty hourly audits, and a key can have at most ten pages waiting at once. A key audits one page per website a day unless the Fukamo operator gave it more (up to 50); an audited page can be audited again as often as needed, and a page past the key's number is refused until tomorrow with a page it can still audit. batch <url> <url> … audits up to ten pages of one website when the Fukamo operator has multi-page audits enabled; otherwise the server says so.

| variable | | |---|---| | FUKAMO_API_KEY | required | | FUKAMO_API_URL | optional, defaults to https://fukamo.com | | FUKAMO_POLL_MS | optional, how often the status is checked; 5000 by default, never under 1000 |

Results are in English. Versions before 0.3.0 used an endpoint that has been retired and now print a message asking you to update.

The CLI holds no audit logic: the server owns the rules, the queue and the limits.

Full reference — endpoints, limits, errors: https://fukamo.com/api. Keys are issued by the Fukamo operator; write to [email protected].