@wallstreetdukes/dukectl

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.4 darwin-arm64 node-v20.12.0
$ dukectl --help [COMMAND]
USAGE
  $ dukectl COMMAND
...

Commands

• dukectl download DATA DESTINATION
• dukectl filings
• dukectl filings parse [BULKPATH] [OUTDIR]
• dukectl filings peek [BULKPATH]
• dukectl help [COMMAND]

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: src/commands/download.ts

dukectl filings

Access filings from the SEC EDGAR bulk download

USAGE
  $ dukectl filings [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Access filings from the SEC EDGAR bulk download

EXAMPLES
  $ dukectl filings

See code: src/commands/filings/index.ts

dukectl filings parse [BULKPATH] [OUTDIR]

Parse and convert SEC filings from their bulk download, into simple JSON files.

USAGE
  $ dukectl filings parse [BULKPATH] [OUTDIR] [-h] [-o <value>] [-b <value>] [-s <value>] [-t <value>] [-c <value>]

ARGUMENTS
  BULKPATH  path to the extracted bulk submissions
  OUTDIR    path to the directory to write the parsed filings to

FLAGS
  -b, --batchSize=<value>  [default: 100] number of items to parse at a time
  -c, --cik=<value>        filter filings by CIK
  -h, --help               Show CLI help.
  -o, --offset=<value>     offset to start reading from
  -s, --startDate=<value>  date to start reading from (e.g. 2021-11-27)
  -t, --toDate=<value>     date to end reading at (e.g. 2023-10-17)

DESCRIPTION
  Parse and convert SEC filings from their bulk download, into simple JSON files.

EXAMPLES
  $ dukectl filings parse

See code: src/commands/filings/parse.ts

dukectl filings peek [BULKPATH]

Peek at filings from the SEC EDGAR bulk download

USAGE
  $ dukectl filings peek [BULKPATH] [-h] [-o <value>] [-l <value>] [--columns <value> | -x] [--filter <value>]
    [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <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
  -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
      --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)

DESCRIPTION
  Peek at filings from the SEC EDGAR bulk download

EXAMPLES
  $ dukectl filings peek

See code: src/commands/filings/peek.ts

dukectl help [COMMAND]

Display help for dukectl.

USAGE
  $ dukectl 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 dukectl.

See code: @oclif/plugin-help