Command line
Eventfox ships a small command line tool. Run it inside the container with docker compose exec eventfox node dist/cli.mjs followed by a command.
Running a command
From the folder with your docker-compose.yml:
docker compose exec eventfox node dist/cli.mjs list-projects
Commands
| Command | What it does |
|---|---|
migrate | Applies database changes. This also happens when Eventfox starts. |
create-project --name <n> --domain <host[,host...]> [--mode standard|privacy] [--allow-localhost] | Creates a project and prints its ID and public key. |
set-domains --project <id> --domain a.com,b.com [--allow-localhost true|false] | Replaces a project's allowed domains. A running server picks the change up within 60 seconds. |
list-projects | Prints each project's name, mode, ID and active public key. |
reset-password --email <e> | Prints a new temporary password for that person. |
delete-visitor --project <id> --visitor-id <id> | Deletes every event for one visitor in a project and prints how many. |
demo:seed --name <n> --mode standard|privacy [--visitors 3000] [--days 60] [--seed 1] | Creates a project full of made-up demo data. |
demo:wipe --project <id> | Deletes a demo project. It refuses any project that isn't a demo. |
licence:status | Shows the installed licence. |
licence:install | Installs a licence. Paste the text when asked; it stays hidden and a * shows for each character. |
licence:remove | Removes the installed licence. |
New projects follow the plan's project limit. Details of each command's output are in --help.