2.0.7 • Published 8 months ago

@disane-dev/docudigger v2.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Document scraper for getting invoices automagically as pdf (useful for taxes or DMS)

šŸ  Homepage

Prerequisites

  • npm >=9.1.2
  • node >=18.12.1

Install

npm install

Usage

$ npm install -g @disane-dev/docudigger
$ docudigger COMMAND
running command...
$ docudigger (--version)
@disane-dev/docudigger/1.0.0-dev.8 win32-x64 node-v18.16.0
$ docudigger --help [COMMAND]
USAGE
  $ docudigger COMMAND
...

Commands

docudigger commands

list all the commands

USAGE
  $ docudigger commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>] [--filter
    <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help         Show CLI help.
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)
  --tree             show tree of commands

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

docudigger help [COMMAND]

Display help for docudigger.

USAGE
  $ docudigger help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for docudigger.

See code: @oclif/plugin-help

docudigger plugins

List installed plugins.

USAGE
  $ docudigger plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ docudigger plugins

See code: @oclif/plugin-plugins

docudigger plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ docudigger plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ docudigger plugins add

EXAMPLES
  $ docudigger plugins:install myplugin 

  $ docudigger plugins:install https://github.com/someuser/someplugin

  $ docudigger plugins:install someuser/someplugin

docudigger plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ docudigger plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ docudigger plugins:inspect myplugin

docudigger plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ docudigger plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ docudigger plugins add

EXAMPLES
  $ docudigger plugins:install myplugin 

  $ docudigger plugins:install https://github.com/someuser/someplugin

  $ docudigger plugins:install someuser/someplugin

docudigger plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ docudigger plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ docudigger plugins:link myplugin

docudigger plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ docudigger plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ docudigger plugins unlink
  $ docudigger plugins remove

docudigger plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ docudigger plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ docudigger plugins unlink
  $ docudigger plugins remove

docudigger plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ docudigger plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ docudigger plugins unlink
  $ docudigger plugins remove

docudigger plugins update

Update installed plugins.

USAGE
  $ docudigger plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

docudigger scrape all

Scrapes all websites periodically

USAGE
  $ docudigger scrape all [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l <value>] [-c <value> -r]

FLAGS
  -c, --recurringCron=<value>  [default: * * * * *] Cron pattern to execute periodically
  -d, --debug
  -l, --logPath=<value>        [default: ./logs/] Log path
  -r, --recurring
  --logLevel=<option>          [default: info] Specify level for logging.
                               <options: trace|debug|info|warn|error>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Scrapes all websites periodically

EXAMPLES
  $ docudigger scrape all

docudigger scrape amazon

Used to get invoices from amazon

USAGE
  $ docudigger scrape amazon -u <value> -p <value> [--json] [--logLevel trace|debug|info|warn|error] [-d] [-l
    <value>] [-c <value> -r] [--fileDestinationFolder <value>] [--fileFallbackExentension <value>] [-t <value>]
    [--yearFilter <value>] [--pageFilter <value>] [--onlyNew]

FLAGS
  -c, --recurringCron=<value>        [default: * * * * *] Cron pattern to execute periodically
  -d, --debug
  -l, --logPath=<value>              [default: ./logs/] Log path
  -p, --password=<value>             (required) Password
  -r, --recurring
  -t, --tld=<value>                  [default: de] Amazon top level domain
  -u, --username=<value>             (required) Username
  --fileDestinationFolder=<value>    [default: ./data/] Amazon top level domain
  --fileFallbackExentension=<value>  [default: .pdf] Amazon top level domain
  --logLevel=<option>                [default: info] Specify level for logging.
                                     <options: trace|debug|info|warn|error>
  --onlyNew                          Gets only new invoices
  --pageFilter=<value>               Filters a page
  --yearFilter=<value>               Filters a year

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Used to get invoices from amazon

  Scrapes amazon invoices

EXAMPLES
  $ docudigger scrape amazon

NPM

npm run start

Console

./bin/dev --help

as CLI (when installed from npm)

npx docudigger --help

Author

šŸ‘¤ Marco Franke

šŸ¤ Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ā­ļø if this project helped you!


This README was generated with ā¤ļø by readme-md-generator

2.0.6-dev.6

8 months ago

2.0.6-dev.7

8 months ago

2.0.6-dev.8

8 months ago

2.0.6-dev.9

8 months ago

2.0.6-dev.3

8 months ago

2.0.6-dev.4

8 months ago

2.0.6-dev.5

8 months ago

2.0.7

8 months ago

2.0.6-dev.11

8 months ago

2.0.6-dev.12

8 months ago

2.0.6-dev.10

8 months ago

2.0.6-dev.15

8 months ago

2.0.6-dev.16

8 months ago

2.0.6-dev.13

8 months ago

2.0.6-dev.14

8 months ago

2.0.7-dev.1

8 months ago

2.0.7-dev.2

8 months ago

2.0.6-dev.2

1 year ago

2.0.6-dev.1

1 year ago

2.0.3

1 year ago

2.0.5

1 year ago

2.0.4

1 year ago

2.0.6

1 year ago

2.0.5-dev.1

1 year ago

2.0.5-dev.2

1 year ago

2.0.4-dev.1

1 year ago

2.0.4-dev.2

1 year ago

2.0.3-dev.6

1 year ago

2.0.3-dev.5

1 year ago

2.0.3-dev.4

1 year ago

2.0.3-dev.3

1 year ago

2.0.3-dev.2

1 year ago

2.0.3-dev.1

1 year ago

2.0.1-dev.4

2 years ago

2.0.1-dev.3

2 years ago

2.0.1-dev.2

2 years ago

2.0.1-dev.1

2 years ago

2.0.2

2 years ago

2.0.1

2 years ago

2.0.0-dev.5

2 years ago

2.0.0-dev.4

2 years ago

2.0.0-dev.3

2 years ago

2.0.0-dev.2

2 years ago

2.0.0-dev.1

2 years ago

2.0.0

2 years ago

1.1.23

2 years ago

1.1.23-dev.1

2 years ago

1.1.17-dev.5

2 years ago

1.1.22

2 years ago

1.1.21

2 years ago

1.1.20

2 years ago

1.1.19

2 years ago

1.1.18

2 years ago

1.1.17

2 years ago

1.1.17-dev.4

2 years ago

1.1.17-dev.3

2 years ago

1.1.17-dev.2

2 years ago

1.1.17-dev.1

2 years ago

1.1.16-dev.2

2 years ago

1.1.16

2 years ago

1.1.16-dev.1

2 years ago

1.1.15

2 years ago

1.1.14

2 years ago

1.1.13

2 years ago

1.1.12

2 years ago

1.1.11

2 years ago

1.1.10

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.3-dev.4

2 years ago

1.1.3-dev.3

2 years ago

1.1.3-dev.2

2 years ago

1.1.3-dev.1

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0-dev.2

2 years ago

1.1.0

2 years ago

1.1.0-dev.1

2 years ago

1.0.1

2 years ago

1.0.0-dev.13

2 years ago

1.0.0-dev.12

2 years ago

1.0.0-dev.11

2 years ago

1.0.0-dev.10

2 years ago

1.0.0-dev.9

2 years ago

1.0.0-dev.8

2 years ago

1.0.0-dev.7

2 years ago

1.0.0-dev.5

2 years ago

1.0.0-dev.4

2 years ago

1.0.0-dev.3

2 years ago

1.0.0-dev.2

2 years ago

1.0.0-dev.1

2 years ago