Skip to main content

CLI for Scholar Inbox (authenticated web API)

Project description

scholarinboxcli

CLI for Scholar Inbox, for humans and agents alike.

Installation

pip install scholarinboxcli

Or with uv:

uv pip install scholarinboxcli

Or run directly with uvx (no install):

uvx scholarinboxcli auth login --url "<magic-link-url>"

Auth

# Log in with the magic-link URL from the web app
scholarinboxcli auth login --url "https://www.scholar-inbox.com/login?sha_key=...&date=MM-DD-YYYY"

# Check current session and user info
scholarinboxcli auth status

# Clear local session config
scholarinboxcli auth logout

Note: auth login extracts sha_key from the URL and authenticates via the API.

Config is stored at ~/.config/scholarinboxcli/config.json. You can override the API base with SCHOLAR_INBOX_API_BASE.

Command reference

Top-level commands:

  • auth (login/status/logout)
  • digest
  • trending
  • search
  • semantic
  • interactions
  • bookmark (list/add/remove)
  • collection (list/create/rename/delete/add/remove/papers/similar)
  • conference (list/explore)

Run scholarinboxcli --help or scholarinboxcli <command> --help for full options.

Quickstart

# Fetch a daily digest by date (MM-DD-YYYY)
scholarinboxcli digest --date 01-30-2026 --json

# Trending papers (last 7 days)
scholarinboxcli trending --category ALL --days 7 --json

# Keyword search
scholarinboxcli search "transformers" --limit 5 --json

# Semantic search
scholarinboxcli semantic "graph neural networks" --limit 5 --json

# List your bookmarks
scholarinboxcli bookmark list --json

Collections

# List collections
scholarinboxcli collection list

# Expanded collection names (marks which collections are expanded server-side)
scholarinboxcli collection list --expanded

# Create, rename, delete
scholarinboxcli collection create "My Collection"

# Rename by ID (or name)
scholarinboxcli collection rename 10759 "New Name"

# Delete by ID (or name)
scholarinboxcli collection delete 10759

# Add/remove papers
scholarinboxcli collection add 10759 4559909
scholarinboxcli collection remove 10759 4559909

# Show papers in a collection
scholarinboxcli collection papers 10759

# Similar papers for one or more collections
scholarinboxcli collection similar 10759 12345

# Optional local sorting for display (e.g., newest first)
scholarinboxcli collection similar "AIAgents" --sort year

# Sort ascending instead
scholarinboxcli collection similar "AIAgents" --sort year --asc

# You can also use collection names (case-insensitive). The CLI will
# automatically fetch collection ID mappings from the API when needed.
scholarinboxcli collection papers "AIAgents"
scholarinboxcli collection similar "AIAgents" "Benchmark"

Collection name matching is exact → prefix → contains. If multiple matches exist, the CLI reports ambiguity and shows candidate IDs. collection similar supports client-side sorting with --sort year|title and optional --asc.

Search

# Full-text keyword search
scholarinboxcli search "transformers" --limit 5

Semantic Search

# Semantic similarity search
scholarinboxcli semantic "graph neural networks" --limit 5

Other commands

# Daily digest view (MM-DD-YYYY)
scholarinboxcli digest --date 01-30-2026

# Trending papers by category
scholarinboxcli trending --category ALL --days 7

# Read/like/dislike interactions feed
scholarinboxcli interactions --type all

# List bookmarks
scholarinboxcli bookmark list

# List known conferences
scholarinboxcli conference list

# Explore conference indices
scholarinboxcli conference explore

Output modes

  • TTY: Rich tables
  • --json: pretty JSON
  • Piped: pretty JSON (auto)

Examples for agents/scripting:

# Auto-JSON when piped
scholarinboxcli collection list | jq '.'

# Explicit JSON output
scholarinboxcli collection papers "AIAgents" --json

# JSON for automation (stable keys)
scholarinboxcli search "diffusion" --json

Notes

  • Some collection mutations (create/rename/delete/add/remove) rely on best-effort endpoints that may change on the service side. If a mutation fails, try again or use the web UI to validate the current behavior.
  • Bookmarks are stored as a dedicated collection named "Bookmarks" in the web app; bookmark list pulls that collection via /api/get_collections.
  • Similar papers for collections uses the server endpoint used by the web UI. Results typically appear under digest_df in JSON responses.

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scholarinboxcli-0.1.2.tar.gz (29.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scholarinboxcli-0.1.2-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file scholarinboxcli-0.1.2.tar.gz.

File metadata

  • Download URL: scholarinboxcli-0.1.2.tar.gz
  • Upload date:
  • Size: 29.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for scholarinboxcli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d84f9a8c7a4cb776fb323992ca03d1af6792ef057793e05fbe2711230172e1a7
MD5 04e914e9b13a27971022cdb34627a688
BLAKE2b-256 52129a533fd5ea57c5aa19fc1fe5c01a2fc9fed433cd8341db0dda5f5f64cb6c

See more details on using hashes here.

File details

Details for the file scholarinboxcli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: scholarinboxcli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for scholarinboxcli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 48168f75bead1e352e9c67751516516a37683c083a615e9164be806f44030d14
MD5 e0d0cf7aaa3f568ab52592e3ccb6560d
BLAKE2b-256 3a100c4c4bc4dffc05c1093e1dcf868ab3bf527d422cc44faae96410a4202dac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page