Get started

Install

Install shipit-agent and the extras for your model provider and tools.

1 min read

ShipIt Agent needs Python 3.11 or newer. Its only required dependency is pydantic; a model provider's SDK, a browser or a vector store is an extra you add when you need it.

bash
pip install shipit-agent

Add your model provider

Install the extra for the provider you use. Several can be installed together.

ProviderExtraEnvironment variables
Anthropicshipit-agent[anthropic]ANTHROPIC_API_KEY
OpenAIshipit-agent[openai]OPENAI_API_KEY
AWS Bedrockshipit-agent[bedrock]AWS_REGION_NAME and AWS credentials
Google Geminishipit-agent[google]GOOGLE_API_KEY
Groqshipit-agent[groq]GROQ_API_KEY
Togethershipit-agent[together]TOGETHER_API_KEY
Ollama (local)shipit-agent[ollama]none
Anything LiteLLM supportsshipit-agent[litellm]the provider's own
bash
pip install 'shipit-agent[anthropic]'

Configure a model covers choosing the model and the full list of settings.

Add tools and features

ExtraWhat it adds
playwrightplaywright_browse, a real browser. Run playwright install chromium once after installing.
pdfThe pdf tool.
filesread_file for Word, Excel, PowerPoint and web pages, converted to Markdown.
sqlThe sql tool (SQLAlchemy). Install your database driver too.
connectorsThe connector catalog (GitHub, Slack, Jira and others).
tts, videotext_to_speech and video_generate.
ragEverything for Super RAG: embedders, vector stores, extractors, rerankers.
langsmith, otelTrace exporters.
allEvery provider, tool and RAG extra.

Check the install

bash
python -c "import shipit_agent; print(shipit_agent.__version__)"
shipit --help

The package installs two commands: shipit, the agent CLI, and shipit-chat, an interactive chat.

Next

Run your first agent in the Quickstart.