Skip to content

Connectors CLI

Use provon connectors to persist connector configuration state and enabled flags for a project. The CLI stores non-secret config and the connector secret; interactive OAuth, issue search, and issue creation run through the Workbench or provon findings handoff.

View as Markdown Open the plain-text version of this page.

Prerequisites#

  • Selected project and authenticated credential with write access to project connectors.
  • For tracker connectors: a token supplied as --secret and the account/default-target config.

Supported Kinds#

Kind Role Config fields
github Issue tracker accountName, defaultOwner, defaultRepo
gitlab Issue tracker instanceUrl (default https://gitlab.com), accountName, defaultNamespace, defaultProject
linear Issue tracker workspaceName, defaultTeamId, defaultProjectId
jira Issue tracker siteUrl, defaultProjectKey, defaultIssueType
huggingface Model/artifact source accountName, defaultRepo

List Connectors#

bash
provon connectors list

Configure A Connector#

bash
provon connectors update github \
  --enabled \
  --config-file ./github-config.json \
  --secret "$GITHUB_TOKEN"

Example ./github-config.json:

json
{
  "accountName": "provon",
  "defaultOwner": "provon",
  "defaultRepo": "provon"
}

Update options:

Flag Meaning
--config-file <path> JSON object of non-secret config fields for the kind
--secret <value> Connector token; omitted fields keep their previous value
--enabled Mark connector enabled
--disabled Mark connector disabled

Rules:

  • Provide at least one change: config, secret, or enabled state (connectors.missing_update otherwise).
  • --enabled and --disabled together are rejected (connectors.conflicting_state).
  • The config file must be a JSON object (connectors.invalid_config).
  • To rotate only the secret, omit --config-file; to flip only state, omit config and secret.

Delete A Connector#

bash
provon connectors delete github

Success Check#

bash
provon connectors list

The connector appears with enabled: true after configuration. Follow a tracker handoff with provon findings handoff <finding-id> --provider github --destination owner=<owner> --destination repo=<repo>; see Findings CLI.

Troubleshooting#

Symptom Likely cause Fix
connectors.missing_update No config, secret, or state supplied Add at least one of --config-file, --secret, --enabled, --disabled
connectors.conflicting_state Both state flags passed Use a single state flag
connectors.invalid_config Config file not a JSON object Validate the file parses with jq . file.json
Handoff fails despite connector enabled Secret missing or default target absent Re-run update with --secret and complete the config fields
Unsupported kind rejected Misspelled kind Use one of the five kinds listed above