@wallstreetdukes/dukectl v0.1.3

EDGAR DUKE CLI

Duke's CLI for wrangling SEC filings from the EDGAR service.

• EDGAR DUKE CLI
• Usage
• Commands

Usage

$ npm install -g @wallstreetdukes/dukectl
$ dukectl COMMAND
running command...
$ dukectl (--version)
@wallstreetdukes/dukectl/0.1.3 darwin-arm64 node-v18.15.0
$ dukectl --help [COMMAND]
USAGE
  $ dukectl COMMAND
...

Commands

• dukectl download DATA DESTINATION
• dukectl filings [BULKPATH]
• dukectl help [COMMANDS]

dukectl download DATA DESTINATION

Download and extract EDGAR bulk data such as submissions and company facts

USAGE
  $ dukectl download DATA DESTINATION [-z <value>] [-h]

ARGUMENTS
  DATA         Bulk data package to download (submissions, companyfacts)
  DESTINATION  Destination folder to extract the data to

FLAGS
  -h, --help                 Show CLI help.
  -z, --zipFilePath=<value>  Path to the zip file to extract

DESCRIPTION
  Download and extract EDGAR bulk data such as submissions and company facts

EXAMPLES
  $ dukectl download

See code: dist/commands/download.ts

dukectl filings [BULKPATH]

Access filings from the SEC EDGAR bulk download

USAGE
  $ dukectl filings [BULKPATH] [-h] [-o <value>] [-l <value>]

ARGUMENTS
  BULKPATH  path to the extracted bulk submissions

FLAGS
  -h, --help            Show CLI help.
  -l, --limit=<value>   [default: 10] number of items to read
  -o, --offset=<value>  offset to start reading from

DESCRIPTION
  Access filings from the SEC EDGAR bulk download

EXAMPLES
  $ dukectl filings

See code: dist/commands/filings.ts

dukectl help [COMMANDS]

Display help for dukectl.

USAGE
  $ dukectl help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for dukectl.

See code: @oclif/plugin-help