Environment Variables

PMS Environment Variables (Core)

• $PMS Path where PMS is installed
  • Default: ~/.pms
• $PMS_LOCAL Path to local files used to override loading
  • Default: $PMS/local
• $PMS_DEBUG Enables PMS Debug Mode
  • Default: 0
• $PMS_THEME Theme that will be used
  • Default: default
  • NOTE: this is managed by PMS and stored in ~/.pms.theme
• $PMS_PLUGINS Array of all the plugins that are used
  • Default: pms $PMS_SHELL
  • NOTE: This is managed by PMS and store in ~/.pms.plugins
• $PMS_SHELL Contains the shell being used, this is set automatically
  • Default: sh
  • NOTE: This should not be manually set

env file loading order

Loading env files is done in a way that it's easy to overwrite any environment variable.

1. env file (if available) from enabled plugins via $PMS directory
2. env file (if available) from enabled plugins via $PMS_LOCAL directory
3. ~/.env
4. ~/.env.$PMS_SHELL
5. ~/.env.local
6. ~/.env.$PMS_SHELL.local

NOTES:

• All env files are optional, PMS will not notify the user if any of these are not found