Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@flux-finance/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@flux-finance/cli

Install and manage FluxFinance — a personal finance AI agent with Telegram bot and web UI.

Quick Start

npx @flux-finance/cli@latest

This launches an interactive setup wizard that guides you through everything.

Prerequisites

Docker Desktop installed and running
Node.js 18+

Setup Wizard

The wizard walks you through:

Docker check — verifies Docker is installed and running
Telegram bot creation — QR code + step-by-step instructions for @BotFather
Telegram user ID — QR code + instructions for @raw_data_bot
Port configuration — choose which port to run the web UI on
Install & start — pulls the Docker image and starts FluxFinance
Optional ngrok — set up remote access

After setup completes, open http://localhost:5173/settings to configure your AI provider.

Commands

Command	Description
`npx @flux-finance/cli`	Run setup wizard (first time) or start FluxFinance
`npx @flux-finance/cli start`	Start FluxFinance
`npx @flux-finance/cli stop`	Stop FluxFinance
`npx @flux-finance/cli status`	Show running status
`npx @flux-finance/cli logs`	View container logs
`npx @flux-finance/cli update`	Pull latest image and restart
`npx @flux-finance/cli config`	Show current configuration
`npx @flux-finance/cli ngrok`	Set up remote access via ngrok
`npx @flux-finance/cli reset`	Wipe configuration (data is preserved)

Configuration

All configuration is stored in ~/.flux-finance/:

~/.flux-finance/
├── .env                 # Credentials and settings
└── data/                # Application data (persisted across updates)
    ├── sqlite/          # Database
    └── backups/         # Backup archives

Environment Variables

Variable	Description
`TELEGRAM_BOT_TOKEN`	Your Telegram bot token from @BotFather
`TELEGRAM_ALLOW_FROM`	Your Telegram user ID
`FLUX_SECRET_KEY`	Auto-generated encryption key
`PORT`	Web UI port (default: 5173)
`NGROK_AUTHTOKEN`	Optional — ngrok token for remote access

Updating

npx @flux-finance/cli update

This pulls the latest Docker image and restarts the container. Your data is preserved.

Uninstalling

npx @flux-finance/cli stop
npx @flux-finance/cli reset

To also remove your data:

rm -rf ~/.flux-finance

License

MIT