Nuvelics documentation
CLICommand reference

nuvelics datasource

Usage, options and details of the nuvelics datasource commands.

nuvelics datasource create

Create a new datasource

Every datasource kind is creatable here. A web datasource takes its feed --url. A vendor datasource takes --vendor plus that vendor's -p params. An x datasource takes --profile follows, with one or more --user, or --profile status with -p tweetId=<id>. A grok-x-search datasource takes -p location=<place>. A council datasource takes its portal --url.

A vendor kind whose adapter authenticates needs its credential named here: store the secret with nuvelics credential create first, then pass that credential's id as --credential-id. Attaching it afterwards with nuvelics datasource update is not an option for those kinds, because the create itself is rejected without one.

The -p flag is for non-secret vendor configuration only. Never place secrets in -p — argv is visible in ps output and shell history.

  • --name <name> — Datasource name
  • --type <type> — Datasource type: web, vendor, x, grok-x-search, or council
  • --profile <follows|status> — For --type x: follows or status
  • --user <username[:userId]> — For x follows: username[:userId], repeatable
  • --follow-links — For --type x: follow canonical article links in pointer posts
  • --url <url> — Feed URL (type web) or portal URL (type council)
  • --vendor <vendor> — Vendor identifier (required for type vendor)
  • --credential-id <id> — Credential to authenticate with (required by authenticated vendor kinds)
  • --topic <topic> — Coverage-hint topic
  • --location <location> — Coverage-hint location
  • -p <key=value> — Vendor parameter key=value (repeatable)

nuvelics datasource delete [id]

Delete a datasource (irreversible, cascades to all articles)

Pass --yes to confirm. Deletes all collected articles and harvest history.

  • --yes — Confirm irreversible cascading deletion

nuvelics datasource disable [id]

Disable a datasource (skips scheduled acquisition)

nuvelics datasource enable [id]

Re-enable a disabled datasource

nuvelics datasource get [id]

Get a datasource by ID

nuvelics datasource list

List datasources

Use --include-disabled to show disabled datasources. Use --filter, --limit, --all, and --cursor to control which datasources are returned.

  • --include-disabled — Include disabled datasources
  • --filter <field.op=value> — Filter: field.op=value (repeatable)
  • --limit <n> — Maximum total datasources to fetch (default 100)
  • --all — Fetch all pages without a count bound
  • --cursor <cursor> — Start from this pagination cursor
  • --include <relation> — Sideload a related entity (allowed: credential). In text mode, credential is included by default.
  • --sort <-field|field> — Sort order: "-field" descending, "field" ascending. Use --sort=-field (with "="), not --sort -field, or the shell/parser reads -field as another flag. Accepted: name, -name, createdAt, -createdAt, updatedAt, -updatedAt (default -updatedAt)

nuvelics datasource run [id]

Run a datasource (trigger acquisition)

nuvelics datasource runs [id]

List harvest runs for a datasource

  • --limit <n> — Maximum number of runs to return (<=200)
  • --sort <-field|field> — Sort order: "-field" descending, "field" ascending. Use --sort=-field (with "="), not --sort -field, or the shell/parser reads -field as another flag. Accepted: startedAt, -startedAt (default -startedAt)

nuvelics datasource update [id]

Update a datasource

The current version is fetched automatically before the update. If the datasource was modified concurrently, a 412 is returned — retry.

  • --name <name> — New display name
  • --url <url> — New feed URL
  • --credential-id <id> — Credential ID to attach; "" to detach
  • --enabled <true|false> — Enable or disable: true or false
  • --fetch-config <json> — Per-datasource HTTP overrides (JSON object)
  • --topic <topic> — Coverage-hint topic; "" to clear
  • --location <location> — Coverage-hint location; "" to clear

Report a problem with this page

On this page