CLI · telipot docs

Pages · CLI

On this page

CLI

Discover, inspect and run a task from your shell, then connect an account when needed.

Set up from source

The CLI is not published to npm yet. In a checkout of the telipot repository, install dependencies with Bun. Run these commands from the repository root.

Shell

bun install
bun run telipot login

login shows a browser link and device code. Sign in, open your organization and approve the code as an owner or admin. The token stays in ~/.config/telipot/credentials, readable by its owner alone.

The examples below use telipot; in the checkout, prefix it with bun run. For a local gateway, set TELIPOT_API_URL before signing in.

Find and inspect a task

Shell

telipot discover 'Hacker News stories about agent tools'
telipot inspect hackernews.news.search

Discovery lists matching tasks, prices and whose credential serves them. Inspection prints the full input and output schema as JSON. Neither calls the provider.

Preview the price, then run

Shell

telipot run hackernews.news.search --input-json '{"query":"agent tools","hitsPerPage":2}' --quote

--quote prints the catalog price and runs nothing. This public task is free. Remove --quote to execute it:

Shell

telipot run hackernews.news.search --input-json '{"query":"agent tools","hitsPerPage":2}'

The vendor's output is JSON on stdout. The call id, anonymous identity and $0 charge appear on stderr. Find the same call under Audit log on the dashboard.

Commands

Command	Does
`telipot login`	Exchanges a browser-approved device code for an organization token
`telipot discover <sentence>`	Lists tasks for a job, with price and identity
`telipot inspect <task>`	Prints the task's schema, price and identity without running it
`telipot run <task> --input-json <json>`	Runs a task; `--quote` previews its catalog price instead
`telipot connect <provider>`	Creates a connect link for the organization or a named end user

Choose the principal and version

--as user:ana acts as that end user. Leave it out for the organization, or the principal fixed to a user-bound token.
--catalog-version 2026-10-04 pins a run to the provider's catalog version. Without a pin, the CLI uses the version currently served.
TELIPOT_TOKEN overrides the saved login token. Keep it in your server environment or secret store.
TELIPOT_API_URL selects another gateway, such as http://localhost:3000 during local development.

Connect an end user's account

First add your callback URL under Settings → Redirect allowlist. Then create a link for Ana:

Shell

telipot connect google-calendar \
  --as user:ana \
  --redirect-uri https://your-app.example/connected

Replace the example URL with your allowlisted callback. The CLI requests the provider's default read scopes. Hand the one-time link to Ana; it expires in fifteen minutes.

Follow the end-user connection guide for callback verification, account selection, retries and revocation.