BrainyFlow
GitHub
BrainyFlow
  • Introduction
    • What is BrainyFlow?
    • Installation
    • Getting Started
    • Comparison
  • Cookbook
    • Python Examples
    • Typescript Examples
  • Core Abstraction
    • Overview
    • Node
    • Flow
    • Memory
  • Design Patterns
    • Overview
    • Agent
    • Workflow
    • RAG
    • Map Reduce
    • Structured Output
    • Multi-Agents (Advanced)
  • Utility Functions
    • Overview
    • LLM Wrapper
    • Web Search
    • Chunking
    • Embedding
    • Vector Databases
    • Text-to-Speech
  • Guides
    • Best Practices
    • Agentic Coding Guide
    • Throttling
    • Visualization & Logging
    • Testing
    • Migrating from PocketFlow
    • Migrating from Older Versions
Powered by GitBook
On this page
  • Alternative: Copy the Source Code
  • Next Steps
Edit on GitHub
  1. Introduction

Installation

Last updated 7 days ago

BrainyFlow is currently available for both Python and TypeScript.

You can install the Python package using pip:

pip install brainyflow

You can install the TypeScript package using pnpm (or npm/yarn):

pnpm add brainyflow
# or
npm install brainyflow
# or
yarn add brainyflow

You can import the JavaScript file directly in the browser using a <script> tag:

<script type="module">
  import * as brainyflow from 'https://unpkg.com/brainyflow@latest/dist/brainyflow.js'

  new brainyflow.Node(...)
</script>

or

<script type="module" src="https://unpkg.com/brainyflow@latest/dist/brainyflow.js"></script>
<script>
  new globalThis.brainyflow.Node(...)
</script>

Alternative: Copy the Source Code

Since BrainyFlow is lightweight and dependency-free, you can also install it by simply copying the source code file directly into your project:

Copy

Copy

Next Steps

Once you have BrainyFlow installed, check out the guide to build your first flow, or explore the to understand the framework's fundamental concepts.

python/brainyflow.py
typescript/brainyflow.ts
Getting Started
Core Abstractions