camoufox-js
This is the JavaScript client for Camoufox. It is a port of the Python wrapper (doesn't call the original Python scripts).
Installation
npm install camoufox-jsThe Camoufox browser itself is downloaded with npx camoufox-js fetch into the
per-user cache directory (~/.cache/camoufox on Linux). Set the
CAMOUFOX_INSTALL_DIR environment variable to install and resolve it from a
custom location instead — useful in containers and CI images where the home
directory is ephemeral or persisted separately (similar to Playwright's
PLAYWRIGHT_BROWSERS_PATH):
CAMOUFOX_INSTALL_DIR=/opt/camoufox npx camoufox-js fetchUsage
You can launch Playwright-controlled Camoufox using this package like this:
import { Camoufox } from 'camoufox-js';
// you might need to run `npx camoufox-js fetch` to download the browser after installing the package
const browser = await Camoufox({
// custom camoufox options
});
const page = await browser.newPage(); // `page` is a Playwright Page instanceAlternatively, if you want to use additional Playwright launch options, you can launch the Camoufox instance like this:
import { launchOptions } from 'camoufox-js';
import { firefox } from 'playwright-core';
// you might need to run `npx camoufox-js fetch` to download the browser after installing the package
const browser = await firefox.launch({
...await launchOptions({ /* Camoufox options */ }),
// other Playwright options, overriding the Camoufox options
});
const page = await browser.newPage(); // `page` is a Playwright Page instanceLaunching a Camoufox server
Camoufox can be ran as a remote websocket server. It can be accessed from other devices, and languages other than Python supporting the Playwright API.
import { launchServer } from 'camoufox-js';
import { firefox } from 'playwright-core';
// you might need to run `npx camoufox-js fetch` to download the browser after installing the package
const server = await launchServer({ port: 8888, ws_path: '/camoufox' });
const browser = await firefox.connect(server.wsEndpoint());
const page = await browser.newPage();
// ...
// Use your browser instance as usual
// ...
await browser.close();
await server.close(); // Close the server when doneMore info
See https://camoufox.com/ or https://github.com/daijro/camoufox for more information on Camoufox.