npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wallstreetdukes/dukectl

v0.1.4

Published

A snazzy, 80s Wall Street-inspired SEC-filings fetching program

Downloads

11

Readme

EDGAR DUKE CLI

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

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

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