sbanken-cli

README

sbanken-cli

sbanken provides an easy way to interact with your bank from the terminal

$ sbanken accounts list
+----------------------------------+--------------------+-----------------------------+-------------+----------+-----------+--------------+
| ID                               | TYPE               | NAME                        | NUMBER      |  BALANCE | AVAILABLE | CREDIT LIMIT |
+----------------------------------+--------------------+-----------------------------+-------------+----------+-----------+--------------+
| D9D073EBC72557BA293288BA311BFB14 | Standard account   | Brukskonto                  | 00000000000 | 13371.33 |  13371.33 |            0 |
+----------------------------------+--------------------+-----------------------------+-------------+----------+-----------+--------------+
|                                  |                    |                             |             | 13371.33 |  13371.33 |            0 |
+----------------------------------+--------------------+-----------------------------+-------------+----------+-----------+--------------+

Prerequisites

• Access to Sbankens API.

Installation

1. Download the latest release
2. Extract the executable binary.

Building from source

Prerequisites

• Go >= 1.13

Build

1. Fetch the repository, for example by using git: git clone git@github.com:engvik/sbanken-cli.git
2. cd sbanken-cli
3. go build -o sbanken cmd/sbanken/main.go

This should produce a binary sbanken, see go help build for more options.

Required configuration

The interact with Sbanken you must provide a client ID, client secret and customer ID. See link under Prerequisites on how to obtain the client ID and client secret. The customer ID is your social security number.

There are three ways to pass these values to sbanken:

Configuration file

client-id: "my-client-id"
client-secret: "my-client-secret"
customer-id: "my-customer-id"

OS	Default config locations
linux	$XDG_CONFIG_HOME/sbanken/config.yaml, $HOME/.config/sbanken/config.yaml
darwin	$XDG_CONFIG_HOME/sbanken/config.yaml, $HOME/Library/Application Support/sbanken/config.yaml
windows	%APPDATA%\sbanken\config.yaml

The config path can also be specified:

sbanken --config ~/.config/sbanken/config.yaml accounts list

or

SBANKEN_CONFIG="~/.config/sbanken/config.yaml" sbanken accounts list

Environment variables

SBANKEN_CLIENT_ID="my-client-id" SBANKEN_CLIENT_SECRET="my-client-secret" CUSTOMER_ID="my-customer-id" sbanken accounts list

Global application options

sbanken --client-id="my-client-id" --client-secret="my-client-secret" --customer-id="my-customer-id" accounts list

Optional configuration

The following configuration can be set by passing a global option or in the configuration file.

Output styles

Global option: --style value Config field: style: value

Available styles:

"bold"
"colored-bright"
"colored-dark"
"colored-black-on-blue-white"
"colored-black-on-cyan-white"
"colored-black-on-green-white"
"colored-black-on-magenta-white"
"colored-black-on-yellow-white"
"colored-black-on-red-white"
"colored-blue-white-on-black"
"colored-cyan-white-on-black"
"colored-green-white-on-black"
"colored-magenta-white-on-black"
"colored-red-white-on-black"
"colored-Yellow-white-on-black"
"double"
"light"
"rounded"

Colors

Global option: --colors Config field: colors: true

Account Aliases

Passing the account ID can be tiring. You can set up aliases for your IDs in the config file.

Config field: account-aliases

Config example:

account-aliases:
    1337539ABCD9357331DCBA1337539ABC: "checking"

Usage example:

sbanken a r --id checking

HTTP Timeout

Number of seconds to wait before timing out http requests.

Global option: --http-timeout value Config option: http-timeout: value Default: 30

Output

Set output format.

Global option: --output value Config option: output: value Default: table

Available formats:

table
json

Usage

NAME:
   sbanken - provides an easy way to interact with your bank from the terminal

USAGE:
   main [global options] command [command options] [arguments...]

VERSION:
   1.6.0

COMMANDS:
   accounts, a        list and read accounts
   cards, c           list cards
   efakturas, e       list, read and pay efakturas
   payments, p        list and read payments
   standingorders, s  list standing orders
   transactions, ta   list transactions
   transfers, tf      transfer money between accounts
   customer, cu       get customer data
   help, h            Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --client-id value, --clid value    the client id [$SBANKEN_CLIENT_ID]
   --client-secret value, -s value    the client secret [$SBANKEN_CLIENT_SECRET]
   --customer-id value, --cuid value  customer id [$SBANKEN_CUSTOMER_ID]
   --style value                      set output style
   --output value                     set output format (default: "table")
   --colors                           add colors to values (default: false)
   --http-timeout value               timeout in seconds (default: 30)
   --config value, -c value           path to YAML config [$SBANKEN_CONFIG]
   --help, -h                         show help (default: false)
   --version, -v                      print the version (default: false)