CLI Tool

The rpt CLI gives you the full Research Protocol surface from the terminal. Install via dotnet tool install -g rpt, then rpt configure to authenticate (prompts for your key without echo, keeping it out of shell history; or set RPT_API_KEY in your environment).

Commands

13 entries

All commands accept --json for scriptable output and --help for inline reference.

rpt searchSearch research notes by free text, sector, ticker, or rating.

--sector: Filter by sector name.
--ticker: Filter by ticker symbol.
--rating: Buy, Hold, or Sell.
--limit: Max results, default 20.

$ rpt search Shell

$ rpt search oil --sector Energy --rating Buy

$ rpt search "UK banks" --json | jq '.results[].title'

rpt noteDisplay the full content of a research note by ticker shortcut or UUID.

--json: Output the raw note metadata + body as JSON.
--no-pager: Print to stdout without paging.

$ rpt note SHEL

$ rpt note a1b2c3d4-e5f6-7890-abcd-ef1234567890

$ rpt note SHEL --json

rpt feedShow the latest research notes from your entitled providers.

--limit: Max number of notes (default 10).
--json: Machine-readable output for piping.

$ rpt feed

$ rpt feed --limit 5

$ rpt feed --json | jq '.notes[].title'

rpt providersList every research provider you have access to.

--json: JSON output suitable for scripting.

$ rpt providers

$ rpt providers --json

rpt clients create <name>Create a client organisation, or attach to the existing one its email domain identifies. Provider admin only, like every clients and contacts command.

--domain: Email domain, e.g. examplefunds.com.
--org-type: buy_side or sell_side.
--institution-type: e.g. asset_manager.
--region: A region the firm covers (repeatable).
--asset-class: An asset class the firm covers (repeatable).
--json: Raw JSON output.

$ rpt clients create "Example Fund Managers" --domain examplefunds.com

rpt clients grant <org-id>Grant a client organisation access to your research, optionally applying one of your access templates.

--access-type: retainer (default), trial or occasional.
--expires-at: Expiry date, e.g. 2027-03-31 (read as UTC).
--template-id: An access template to apply.
--json: Raw JSON output.

$ rpt clients grant 11111111-2222-3333-4444-555555555555 --access-type trial

rpt contacts invite <org-id> <email>Add people to a client organisation, or update their names: one from arguments, or up to 500 from a CSV of org_id,email,display_name,role. No email is sent.

--name: Display name.
--role: member or viewer at a client; admin only in your own organisation.
--file: CSV of contacts, instead of <org-id> <email>.
--preview: Show each row's outcome and write nothing.
--json: Raw JSON output.

$ rpt contacts invite 11111111-2222-3333-4444-555555555555 [email protected] --name "Pat Example"

$ rpt contacts invite --file contacts.csv --preview

rpt contacts remove <user-id>Remove a person who has left a client firm. Refused when other research providers also serve the firm; the error names the per-user deny alternative.

--dry-run: Print the call without making it.
--json: Raw JSON output.

$ rpt contacts remove aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

rpt configureSet or view CLI configuration. Stores your API key at ~/.rpt/config with owner-only permissions.

--api-key: Set the API key for authenticated calls.
--url: Override the hub URL (defaults to http://localhost:8000; alias: --base-url).
--show: Print current settings without modifying them.

$ rpt configure --api-key rsc_abc123

$ rpt configure --url https://www.researchprotocol.io

$ rpt configure --show

rpt watchlist listList every watchlist for the authenticated user with the tickers each contains.

$ rpt watchlist list

rpt watchlist add <ticker>Add a ticker to a named watchlist. Default watchlist if --name is omitted.

--name: Watchlist to add into (defaults to "Default").

$ rpt watchlist add SHEL

$ rpt watchlist add MSFT --name Tech

rpt watchlist remove <ticker>Remove a ticker from a watchlist.

--name: Watchlist to remove from.

$ rpt watchlist remove SHEL

rpt watchlist monitorCheck for recent research on every ticker in a watchlist within a lookback window.

--name: Watchlist to monitor (defaults to "Default").
--days: Lookback window in days, default 7.

$ rpt watchlist monitor

$ rpt watchlist monitor --name Energy --days 14