actual-helpers/README.md

Actual Budget Helper Scripts

This is a collection of useful scripts to help you manage your Actual Budget.

Requirements

• Actual Budget
• Node.js (21.6.2+)
  • @actual-app/api
  • dotenv
  • jsdom

Configuration

Create a .env file in the root directory with the following content:

ACTUAL_SERVER_URL="https://<Actual Budget server URL>"
ACTUAL_SERVER_PASSWORD="<Actual Budget server password>"
ACTUAL_SYNC_ID="<Actual Budget sync ID>"

# optional, for encrypted files
ACTUAL_FILE_PASSWORD="<file password>"

# optional, if you want to use a different cache directory
ACTUAL_CACHE_DIR="./cache"

Installation

Run npm install to install any required dependencies.