Skip to content

Ergomatic is a generic off-chain execution framework for Ergo bots

License

Notifications You must be signed in to change notification settings

nautls/ergomatic

Repository files navigation

Ergomatic

ci Discord badge

ergomatic is a generic off-chain execution framework for bots. Bot functionality is provided via plugins which are audited by the nautilus team.

Install

Shell (Mac, Linux):

curl -fsSL https://raw.githubusercontent.com/nautls/ergomatic/main/scripts/install/install.sh | sh

PowerShell (Windows):

irm https://raw.githubusercontent.com/nautls/ergomatic/main/scripts/install/install.ps1 | iex

Running

Ergomatic can be ran using the run CLI command. The -c flag can optionally be passed to specify the config file path, if not provided it will default to $CWD/ergomatic.yaml.

ergomatic run

Logs can be viewed in your terminal and are also persisted to disk depending on OS:

  • Linux: $XDG_DATA_HOME/ergomatic
  • macOS: $HOME/Library/Application Support/ergomatic
  • Windows: $LOCALAPPDATA/ergomatic

Log files will automatically be rotated with a maximum of 300mb of logs kept.

Contributing

We appreciate your help!

To contribute, please read our contributing instructions.