CLI

pulserie is a small command-line client for the same API. Manage sites, fields, and changes without leaving your terminal.

Install

Node 18 or newer. Install globally from npm:

bash
npm i -g pulserie

Log in

Run login and paste an API key from Settings, API keys. The key is written to ~/.pulserie/config.json and reused on every command. Point the CLI at a different API host with PULSERIE_API_URL.

bash
pulserie login

Commands

  • pulserie loginStore your API key for future commands
  • pulserie whoamiShow the authenticated organization
  • pulserie sites listList your sites
  • pulserie sites add <url> --name <name> --mode <page|list> --max-pages <n>Add a site (only <url> is required)
  • pulserie sites remove <id>Delete a site
  • pulserie fields <siteId> listList a site's fields
  • pulserie fields <siteId> add --name <name> --description <text> --kind <text|number>Add a field to a site
  • pulserie crawl <siteId>Trigger a crawl now
  • pulserie changes --site <id> --followList changes; --follow streams new ones

JSON output

Add the global --json flag to any command to print raw JSON instead of the formatted table, ready to pipe into jq or a script.

bash
pulserie sites list --json

Exit codes

Commands exit 0 on success and a non-zero code on failure, so you can gate a shell script or CI step on the result. Authentication and API errors are printed to stderr with the same error value the API returns.