Nuvelics documentation
CLICommand reference

nuvelics newsdesk

Usage, options and details of the nuvelics newsdesk commands.

nuvelics newsdesk create

Create a new newsdesk

  • --name <name> — Newsdesk name
  • --description <description> — Free-text description of the newsdesk's purpose
  • --audience <audience> — Free-text description of the intended readership
  • --custom-instructions <instructions> — Editorial guidance passed to pitch generation
  • --content-language <language> — Output language for this newsdesk's pitches
  • --topic <topic> — Beat topic (repeatable)
  • --location <location> — Beat location (repeatable)
  • --datasource-id <id> — Datasource ID to subscribe (repeatable)

nuvelics newsdesk delete [id]

Delete a newsdesk (irreversible)

Pass --yes to confirm. This action is irreversible.

  • --yes — Confirm irreversible deletion

nuvelics newsdesk get [id]

Get a newsdesk by ID

nuvelics newsdesk list

List newsdesks

  • --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 newsdesk set-datasources ...

Replace a newsdesk's datasource subscription

Pass no datasource IDs to clear the subscription. The current version is fetched automatically before the write. If the newsdesk was modified concurrently, a 412 is returned — retry.

nuvelics newsdesk update [id]

Update a newsdesk

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

  • --name <name> — New display name
  • --description <description> — New description
  • --audience <audience> — New audience description
  • --custom-instructions <instructions> — New editorial guidance
  • --content-language <language> — New output language for this newsdesk's pitches
  • --topic <topic> — Beat topic (repeatable; replaces the full set)
  • --location <location> — Beat location (repeatable; replaces the full set)
  • --enabled <true|false> — Enable or disable: true or false

Report a problem with this page

On this page