Skip to content
Prevail Prevail

Using connectors

Connectors are driven from the shell with prevail connectors … or from the cockpit with /connectors.

List what’s available

Section titled “List what’s available”
Terminal window
prevail connectors list

Shows every connector, its auth type, and whether it’s currently authenticated. In the cockpit, the apps sidebar shows the same status inline: ✓ connected, ! needs attention, · not configured.

Test a connection

Section titled “Test a connection”
Terminal window
prevail connectors test plaid

Probes the connector’s auth without doing real work — checks that an API key is present, a refresh token is valid, or a browser session is still live. prevail connectors probe <id> is the same thing.

Authenticate

Section titled “Authenticate”

  1. API-key connectors read from your environment or auth/ folder. Set the documented variable (e.g. PLAID_CLIENT_ID) and test will go green.

  2. OAuth connectors need a one-time browser flow:

    Terminal window
    prevail connectors oauth youtube-analytics

    Prevail opens the consent page, listens on a loopback port for the callback, exchanges the code, and stores the refresh token at chmod 0600. From then on it refreshes the access token automatically.

  3. Browser connectors capture a session by driving the real site once with Playwright; re-run the auth if the session goes stale.

  4. Manual connectors just need you to drop exported files into the connector’s watched folder.

In the cockpit, the same flows are available as /connectors oauth <id> and /connectors test <id>.

See what a connector can do

Section titled “See what a connector can do”
Terminal window
prevail connectors skills plaid

Lists the runnable skills a connector exposes — discrete actions like sync-transactions, get-balance, or list-institutions.

Run a connector skill

Section titled “Run a connector skill”
Terminal window
prevail connectors run plaid sync-transactions
prevail connectors run plaid sync-transactions --input institution=chase --input months=3

Pass parameters with repeated --input key=value flags. The skill does its work — syncing data into ~/.prevail/connectors/<id>/data/ — and logs the run under the connector’s _log/.

A typical first run

Section titled “A typical first run”
Terminal window
prevail connectors list                       # what's here?
prevail connectors oauth google-calendar      # authenticate
prevail connectors test google-calendar       # confirm it's green
prevail connectors skills google-calendar     # what can it do?
prevail connectors run google-calendar sync   # pull events in

Now open the calendar domain in the cockpit and your real events are part of the context the council reasons over.