Environment variables
Abstrax does not define environment variables to configure core CLI behaviour. The exceptions below are for MySQL automation and plugin registry overrides.
Global flags instead of environment variables
Abstrax behaviour is controlled by flags rather than the environment:
| Flag | Effect |
|---|---|
--json |
Output machine-readable JSON |
--json-stream |
Output NDJSON progress events plus a final result line |
--dry-run |
Show what would happen without making changes |
--yes |
Skip confirmation prompts |
--quiet |
Reduce output |
--verbose |
Increase output, including the underlying commands run |
--no-color |
Disable coloured output |
--allow-blocked-plugin |
Allow execution of registry-blocked plugins (repeatable) |
You can apply these per command. There is no configuration file or environment variable to set them globally.
MySQL automation
| Variable | Effect |
|---|---|
ABSTRAX_MYSQL_ROOT_PASSWORD |
Root password for mysql install and mysql reset-root-password when --root-password is omitted |
Use this for automation instead of passing a password on the command line. A value in the environment may still be visible to other processes on the host.
Plugin environment variables
When Abstrax launches a plugin, it sets these variables on the plugin process:
| Variable | Value |
|---|---|
ABSTRAX_PLUGIN |
1 |
ABSTRAX_PLUGIN_PROTOCOL |
1 |
ABSTRAX_BINARY |
Absolute path to the abstrax binary |
ABSTRAX_VERSION |
Current Abstrax semver |
To override the plugin registry URL:
| Variable | Effect |
|---|---|
ABSTRAX_PLUGIN_REGISTRY |
Base URL for the plugin registry (overrides config file) |
See Plugins overview and Integrating with Abstrax for details.
Environment that does affect Abstrax indirectly
While Abstrax has no variables of its own, it runs as a normal process and the usual environment still applies:
PATH- Abstrax finds the tools it manages (apt,systemctl,ufw,nginx,certbot,supervisorctl,mysql, and so on) by looking them up on thePATH. Abstrax also searchesPATHfor plugin binaries namedabstrax-<name>. If a tool is installed in a non-standard location that is not on thePATH, Abstrax may report it as not found. Theabstrax doctorcommand uses the same lookup.- The invoking user - whether you are root determines which commands you can run. See Permissions.
Setting environment for managed jobs
Some commands let you set environment variables for the processes they create. These are not Abstrax's own environment; they are written into the job or daemon definition:
abstrax cron add ... --env=KEY=VALUEsets variables for a cron job.abstrax daemon add ... --environment=KEY=VALUEsets variables for a Supervisor program.
Both flags can be repeated to set multiple variables.
sudo abstrax cron add report --command="php8.5 artisan report" --daily --env=APP_ENV=production
sudo abstrax daemon add worker --command="node worker.js" --environment=NODE_ENV=production