Skip to main content

Pydantic AI CLI: command line interface to chat to LLMs

Project description

clai

CI Coverage PyPI versions license

(pronounced "clay")

Command line interface to chat to LLMs, part of the Pydantic AI project.

Usage

You'll need to set an environment variable depending on the provider you intend to use.

E.g. if you're using OpenAI, set the OPENAI_API_KEY environment variable:

export OPENAI_API_KEY='your-api-key-here'

Then with uvx, run:

uvx clai

Or to install clai globally with uv, run:

uv tool install clai
...
clai

Or with pip, run:

pip install clai
...
clai

Either way, running clai will start an interactive session where you can chat with the AI model. Special commands available in interactive mode:

  • /exit: Exit the session
  • /markdown: Show the last response in markdown format
  • /multiline: Toggle multiline input mode (use Ctrl+D to submit)
  • /cp: Copy the last response to clipboard

Help

usage: clai [-h] [-l] [--version] [-m MODEL] [-a AGENT] [-t CODE_THEME] [--no-stream] [prompt]

Pydantic AI CLI v...

subcommands:
  web           Start a web-based chat interface for an agent
                Run "clai web --help" for more information

positional arguments:
  prompt                AI prompt for one-shot mode. If omitted, starts interactive mode.

options:
  -h, --help            show this help message and exit
  -l, --list-models     List all available models and exit
  --version             Show version and exit
  -m MODEL, --model MODEL
                        Model to use, in format "<provider>:<model>" e.g. "openai:gpt-5" or "anthropic:claude-sonnet-4-6". Defaults to "openai:gpt-5".
  -a AGENT, --agent AGENT
                        Custom Agent to use: a module path like "module:variable" or a YAML/JSON spec file like "agent.yml"
  -t CODE_THEME, --code-theme CODE_THEME
                        Which colors to use for code, can be "dark", "light" or any theme from pygments.org/styles/. Defaults to "dark" which works well on dark terminals.
  --no-stream           Disable streaming from the model

For more information on how to use it, see the CLI documentation.

Web Chat UI

Launch a web-based chat interface:

clai web -m openai:gpt-5.2

Web Chat UI

This will start a web server (default: http://127.0.0.1:7932) with a chat interface.

You can also serve an existing agent. For example, if you have an agent defined in my_agent.py:

from pydantic_ai import Agent

my_agent = Agent('openai:gpt-5.2', instructions='You are a helpful assistant.')

Launch the web UI with:

clai web --agent my_agent:my_agent

For full Web UI documentation, see Web Chat UI.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clai-1.87.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clai-1.87.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file clai-1.87.0.tar.gz.

File metadata

  • Download URL: clai-1.87.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for clai-1.87.0.tar.gz
Algorithm Hash digest
SHA256 9c0b5070cf2511c06029fddfc4266045588f45eac6106c2a5efacd4abd9aaf17
MD5 0f6ec7c3b3a4c5481fbba791116c8d92
BLAKE2b-256 9ad7eb6653d2f54e1d85eebf53f563ed6d86a68f231105fa37223f34936b31b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for clai-1.87.0.tar.gz:

Publisher: ci.yml on pydantic/pydantic-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clai-1.87.0-py3-none-any.whl.

File metadata

  • Download URL: clai-1.87.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for clai-1.87.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5950652ea51833e4dddc0218dac25a2526d678bfb3a8b4741d0492297f05eebe
MD5 97dc290695ded255bed4e6703a177700
BLAKE2b-256 41711936dbe178c28b3a4ff389c9c89f8f9d7b16c583888694414cac5a947933

See more details on using hashes here.

Provenance

The following attestation bundles were made for clai-1.87.0-py3-none-any.whl:

Publisher: ci.yml on pydantic/pydantic-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page