@ynab-cli/cli

YNAB CLI

CLI tool for YNAB budgeting software

Warning

This tool is a work in progress. Contributions are welcome.

Install

$ npm install -g @ynab-cli/cli

Current functionality

# Output usage information
$ ynab [command] -h

auth

$ ynab auth [options]

The auth command sets up authentication for the rest of the application. Simply run ynab auth -t <your api token here>, and subsequent commands will use your authorization. Instructions for obtaining an access token are the same as for the YNAB API:

To use this client, you must obtain an access token from the My Account area of the YNAB web application.

options	info
-t, --token <token>	set token
-u, --user	get current user information

budget

$ ynab budget [options]

options	info
-l, --list	list budgets
-u, --use <budgetId>	use budget for subsequent commands

category

$ ynab category [options]

options	info
-l, --list [budgetId]	list categories

account

$ ynab account [options]

options	info
-l, --list [budgetId]	list accounts

Goals

Check out the project to see what needs to get done.

Development

This tool utilizes awilix for IoC and commander for the CLI. A wrapper has been written around both of them so that a Controller-Service architecture can be used. Use the npm scripts below to aid development.

# build
$ npm run build

# build and run
$ npm run dev

# just run
$ npm run start

# build and run with --inspect-brk
$ npm run deb-debug

# lint
$ npm run lint

Contrtibutors

• Martin Fracker [e-mail] (affiliation: Improving)