Skip to content

kindgi connections

View as Markdown

Synopsis

Terminal window
kindgi connections <command>
Signature

Connections: accounts at other apps that tools act with (list / get / connect / disconnect).

Commands

Command Description
kindgi connections list List connections: a member's own, every one for a tenant admin.
kindgi connections get One connection: whose account it is, its permissions and its state.
kindgi connections connect Connect your account at an app (the company's with --for-company): prints the link to open, and at a terminal waits until the connect finishes and says whose account it is.
kindgi connections disconnect Disconnect: withdraws the access at the app where it can, destroys the token, and prints what was done.

See also

Synopsis

Terminal window
kindgi connections list [--project=<project-id>] [--app=<app>] [--mine] [--include-removed] [--limit=<n>] [--cursor=<c>] [--table]
Signature

List connections: a member's own, every one for a tenant admin. --mine keeps to your own. Removed ones are left out unless --include-removed.

Options

Option Default Description
--app <value> none Only this app's, by its entry id: google, microsoft, github, linkedin.
--cursor <value> none The next page, from nextCursor.
--include-removed off Removed connections too, with when (removedAt).
--limit <value> 25 (at most 100) Page size.
--mine off Only your own, even as a tenant admin.
--project <value> none Only those whose registration allows this project.

Every command also takes the global flags.

Examples

List your own connections to Google, as a table.

Terminal window
kindgi connections list --app=google --mine --table

List the connections a project's registrations allow.

Terminal window
kindgi connections list --project=<project-id>

List connections, removed ones too, as a table.

Terminal window
kindgi connections list --include-removed --table

See also

Synopsis

Terminal window
kindgi connections get <connection-id>
Signature

One connection: whose account it is, its permissions and its state.

Options

Every command also takes the global flags.

Examples

Show one connection: whose account, its permissions and its state.

Terminal window
kindgi connections get <connection-id>

See also

Synopsis

Terminal window
kindgi connections connect <app> [--app-id=<registration-id>] [--project=<project-id>] [--permissions=<key>,…] [--for-company]
Signature

Connect your account at an app (the company's with --for-company): prints the link to open, and at a terminal waits until the connect finishes and says whose account it is. --quiet prints the link alone, and still waits.

Options

Option Default Description
--app-id <value> none: the app's one registration Which registration, when the tenant has more than one for the app.
--for-company off Connect the company's account, not your own. Tenant admins only.
--permissions <value> none picked: at a terminal it asks about each one the app's entry offers; required without one The entry's permission keys to ask for, comma-separated (gmail.send,gmail.readonly). Left out, it asks you at the terminal about each one the app's entry offers, none picked for you; without a terminal it's required.
--project <value> none The project it's for; the registration must allow it.

Every command also takes the global flags.

Examples

Connect your Google account to send email; open the link it prints.

Terminal window
kindgi connections connect google --permissions=gmail.send

Connect the company's GitHub installation for a project (tenant admins).

Terminal window
kindgi connections connect github --project=<project-id> --for-company

From Connect your apps:

Terminal window
npx --yes @kindgi/cli@0.2 connections connect google --permissions=gmail.send

See also

Synopsis

Terminal window
kindgi connections disconnect <connection-id> [--yes]
Signature

Disconnect: withdraws the access at the app where it can, destroys the token, and prints what was done. Asks first, unless --yes.

Options

Option Default Description
--yes off Don't ask first (for scripts).

Every command also takes the global flags.

Examples

Disconnect a connection without being asked (for scripts).

Terminal window
kindgi connections disconnect <connection-id> --yes

From How connections work:

Terminal window
npx --yes @kindgi/cli@0.2 connections disconnect <connection-id>

See also