@spike/pdf-cli

@spike/pdf-cli allows you to to extract transactions from South African bank statements (pdfs). The list of supported pdf formats can be found here:

• supported bank statements
• supported credit card statements

Usage

NOTE: @spike/pdf-cli is installed as an executable script called spike-pdf-cli (see package.json:bin)

spike-pdf-cli <command>

Commands:
  spike-pdf-cli configure  Configure the tool with your keys
  spike-pdf-cli folder     Recurse through a folder and process all .pdfs found
  spike-pdf-cli single     Process a single .pdf
  spike-pdf-cli combine    combine .json output from previously processed pdfs into a single .csv

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]

Demo

Video

This video shows the @spike/pdf-cli in action. NOTE: the link below opens in YouTube - make sure that you have YouTube > Setting > Quality = 1080p (or at least 720p) in order to see the text in the video.

Spike API

Behind the scenes @spike/pdf-cli uses @spike/api-statements in order to extract transactions. This involves sending your pdfs to our servers where the parsing and extracting takes place. @spike/pdf-cli simply contains functionality to find pdfs on your local filesystem, send them to the Spike servers, and process the json responses.

More info on the @spike/api-statements can be found here:

• @spike/api-statements
• api docs

Source code

You can access the source code for @spike/pdf-cli in the Spike public monorepo:

# clone source code and install package dependencies:
git clone https://github.com/spikedata/samples
cd samples
yarn

# run
node ./samples/pdf-cli/src/run --help