JSPM

sharesight-cli

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14
  • Score
    100M100P100Q68156F
  • License ISC

Unofficial CLI client for Sharesight

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sharesight-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    sharesight-cli

    Unofficial CLI client for Sharesight, designed with AI agent workflows in mind.

    Commands

    • sharesight auth login
    • sharesight auth status
    • sharesight auth logout
    • sharesight list portfolios
    • sharesight list groupings
    • sharesight defaults set [--portfolio <id-or-name>] [--grouping <grouping-or-custom-name-or-id>] [--include-sales|--exclude-sales] [--format <json|jsonl>]
    • sharesight defaults show
    • sharesight get performance [--portfolio <id-or-name>] [--start-date YYYY-MM-DD] [--end-date YYYY-MM-DD] [--include-sales|--exclude-sales] [--grouping <grouping-or-custom-name-or-id>] [--format <json|jsonl>]

    Installation

    npm install
npm run build

    Run during development:

    npm run dev -- --help

    Authentication

    Each user uses their own Sharesight OAuth client_id and client_secret.

    Paying Sharesight subscribers can contact Sharesight support and ask them to provision an API account for personal use.

    You can provide credentials in two ways:

    1. Recommended for interactive use:
    • sharesight auth login
    • Credentials are stored in OS secure storage when available (secret-tool on Linux, security on macOS).
    • If secure storage is unavailable, the CLI falls back to a local credentials file with restricted permissions and prints a warning.
    1. Recommended for automation/CI:
    • Set SHARESIGHT_CLIENT_ID and SHARESIGHT_CLIENT_SECRET.

    Use sharesight auth status to see which credential backend is currently active.

    Defaults

    Set defaults once, then run report commands without repeating flags.

    • Show current defaults:
      • sharesight defaults show
    • Set default portfolio and grouping together:
      • sharesight defaults set --portfolio "Main Portfolio" --grouping market
    • Set only one default:
      • sharesight defaults set --portfolio 123
      • sharesight defaults set --grouping "Long Term"
      • sharesight defaults set --include-sales
      • sharesight defaults set --exclude-sales
      • sharesight defaults set --format jsonl

    Lists

    • Portfolios:
      • sharesight list portfolios
    • Groupings (built-in + custom):
      • sharesight list groupings

    Get performance

    sharesight get performance --format json
sharesight get performance --portfolio 123 --format json
sharesight get performance --start-date 2024-01-01 --end-date 2024-12-31 --include-sales
sharesight get performance --exclude-sales
sharesight get performance --grouping market
sharesight get performance --grouping 123
sharesight get performance --grouping "Long Term"
    • If --portfolio is omitted, get performance uses the default portfolio from defaults set.
    • If --grouping is omitted, get performance uses the default grouping from defaults set or otherwise falls back to the Sharesight default.
    • If --include-sales / --exclude-sales is omitted, get performance uses the sales default from defaults set or otherwise falls back to the Sharesight default.
    • If --format is omitted, get performance uses the output format default from defaults set (or json if unset).
    • --grouping accepts:
      • standard grouping names (market, currency, etc.)
      • custom grouping ID (e.g. 123)
      • custom grouping exact name (e.g. "Long Term")

    Global options:

    • --base-url (default https://api.sharesight.com)
    • --timeout-ms (default 30000)

    Output formats

    • json (default): pretty JSON output (recommended for AI agents)
    • jsonl: one JSON record per line (best for pipelines)

    Development checks

    npm run lint
npm run test
npm run build