/crewAI-quickstart

A collection of notebooks, cookbooks, and recipes showcasing fun and effective ways to use CrewAI's agentic workflow implementations and tools.

Primary LanguageJupyter NotebookMIT LicenseMIT

OpenAI Cookbook Logo

Build GitHub Docs On Codespaces

CrewAI Quickstart offers a cookbook of code templates and guides designed to help developers build with CrewAI. It includes easily copy-able code snippets that you can seamlessly integrate into your own projects.

Prerequisites

To make the most of the examples in this quickstart guide, you'll need to be familiar with CrewAI. We recommend reviewing the official CrewAI documentation at https://docs.crewai.com/ to understand the basic concepts and functionality. You'll also need an API key from one of the major Language Model providers such as Anthropic, OpenAI, Groq, or Cohere.

Table of Contents

Quickstart Templates

Basic Notebooks

Notebooks with Tool Use

Tool Name Description Notebook Link
TXTSearchTool RAG tool for searching within text (.txt) files Sequential .txt Search Notebook
CodeDocsSearchTool RAG tool for searching through code documentation Sequential Code Docs Search Tool Notebook
CodeInterpreterTool Tool for interpreting Python code Sequential Code Interpreter Notebook
ComposioTool Enables use of Composio tools Sequential Composio SDK Tool Notebook
CSVSearchTool RAG tool for searching within CSV files Sequential CSV lookup Notebook
DirectoryReadTool Facilitates reading of directory structures Sequential Directory Read Tool Notebook
DOCXSearchTool RAG tool for searching within DOCX documents Sequential DOCX Search Notebook
GithubSearchTool RAG tool for searching within GitHub repositories Sequential GitHub Search Notebook
BrowserbaseLoadTool Tool for interacting with web browsers Sequential Headless Browser Notebook
JSONSearchTool RAG tool for searching within JSON files Sequential JSON Search Notebook
MDXSearchTool RAG tool for searching within Markdown (MDX) files Sequential MDX Search Notebook
PDFSearchTool RAG tool for searching within PDF documents Sequential PDF Search Notebook
PGSearchTool RAG tool for searching within PostgreSQL databases Sequential PostgreSQL Search Notebook
ScrapeWebsiteTool Facilitates scraping entire websites Sequential Web Scraping Notebook
SeleniumScrapingTool Web scraping tool using Selenium Sequential Web Scraping (Selenium) Notebook
SerperDevTool Specialized tool for development purposes Sequential Web Search Notebook
WebsiteSearchTool RAG tool for searching website content Sequential Website Search Notebook
XMLSearchTool RAG tool for searching within XML files Sequential XML Search Notebook
YoutubeChannelSearchTool RAG tool for searching within YouTube channels Sequential YouTube Channel Search Notebook
YoutubeVideoSearchTool RAG tool for searching within YouTube videos Sequential YouTube Video Search Notebook

Extra Notebooks

Python Scripts

GUI with Streamlit

Local LLMs

Contributing

The CrewAI Quickstart thrives on the contributions of the developer community. We value your input, whether it's submitting an idea, fixing a typo, adding a new guide, or improving an existing one. By contributing, you help make this resource even more valuable for everyone.

To avoid duplication of efforts, please review the existing issues and pull requests before contributing.

If you have ideas for new examples or guides, share them on the issues page.

Credits

Thanks to @AbubakrChan for his contribution to the 🖼️ GUI w/ Streamlit .py templates.

License

This project is licensed under the MIT License.

Happy learning and coding with CrewAI!