Tutorial: command-line interface

Prerequisites

Overview

With Ibis Birdbrain installed, you can use the birdbrain CLI:

$ birdbrain
 Usage: birdbrain [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────╮
│ --version                     Show version.                                    │
│ --install-completion          Install completion for the current shell.        │
│ --show-completion             Show completion for the current shell, to copy   │
│                               it or customize the installation.                │
│ --help                        Show this message and exit.                      │
╰────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────╮
│ ipy                                     ipy                                     │
│ test                                    test                                   │
╰────────────────────────────────────────────────────────────────────────────────╯

Starting an interactive Python session

You can use the ipy subcommand to start an interactive Python session with Ibis Birdbrain ready to use:

$ birdbrain ipy
access to: birdbrain
model: azure_openai/gpt-4-32k
Python 3.11.5 (main, Sep 14 2023, 13:17:51) [Clang 14.0.3 (clang-1403.0.22.14.1)]
Type 'copyright', 'credits' or 'license' for more information
IPython 8.16.0 -- An enhanced Interactive Python. Type '?' for help.

[ins] In [1]: birdbrain
Out[1]: <Bot: birdbrain>

[ins] In [2]:

Next steps

Learn how to work with Ibis Birdbrain in Python.

Back to top