Skip to content

PaperBreakdown/paperbd-cli

Repository files navigation

paperbd-cli

PaperBD command-line client.

This repo builds the JavaScript distribution used by the public paperbd npm package.

Paper Breakdown: https://paperbreakdown.com

Install

Recommended installer:

npx install-paperbd@latest

Install or upgrade the CLI:

npx install-paperbd@latest

Manual skill install:

npx skills add PaperBreakdown/paperbd-cli --skill paperbd-study-paper

Login

Authenticate in your browser:

paperbd login

After you complete login, return to the terminal and the CLI will finish automatically.

Commands

Show help:

paperbd --help

Check login status:

paperbd status

List your available papers:

paperbd papers

Check your remaining usage:

paperbd usage

Ask about a paper by arXiv ID:

paperbd ask --arxiv 2401.1234 --query "What training setup did they use?"

paperbd ask returns relevant PDF passages for the paper and query. It also automatically tries to add the paper to your accessible paper list.

Log out:

paperbd logout

Notes

  • paperbd papers lists the papers you currently have access to.
  • paperbd usage shows your remaining paper analyses, remaining CLI requests, and when the quota resets.
  • Paper analysis means accessing new papers you have never read with Paper Breakdown.
  • CLI requests means every successful CLI query reduces that count.
  • If a paper is not already available to your account, paperbd ask will try to add it automatically.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors