/PocketFlow-Typescript

Pocket Flow: A minimalist LLM framework. Let Agents build Agents!

Primary LanguageTypeScriptMIT LicenseMIT

License: MIT Docs

PocketFlow.js

PocketFlow.js is a TypeScript port of the original Python version - a minimalist LLM framework.

Table of Contents

Features

  • Lightweight: Zero bloat, zero dependencies, zero vendor lock-in.

  • Expressive: Everything you love—(Multi-)Agents, Workflow, RAG, and more.

  • Agentic Coding: Let AI Agents (e.g., Cursor AI) build Agents—10x productivity boost!

Installation

npm install pocketflow

Alternatively, you can simply copy the source code directly into your project.

Quick Start

Run the following command to create a new PocketFlow project:

npx create-pocketflow

Use cursor/windsurf/any other LLM builtin IDE to open the project.
You can type the following prompt to the agent to confirm the project is setup correctly:

Help me describe briefly about PocketFlow.js

Simply start typing your prompt, and the AI agent will build the project for you.
Here's a simple example:

I want to create an application that can write novel:

1. User can enter a novel title
2. It will generate a outline of the novel
3. It will generate a chapter based on the outline
4. It will save the chapter to ./output/title_name.md

First, read the requirements carefully.
Then, start with design.md first. Stop there until further instructions.

Once you have the design, and you have no questions, start the implementation by simply typing:

Start implementing the design.

Documentation

  • Check out the official documentation for comprehensive guides and examples. The TypeScript version is still under development, so some features may not be available.
  • For an in-depth design explanation, read our design essay

Testing

To run tests locally:

# Install dependencies
npm install

# Run tests
npm test

Contributing

We welcome contributions from the community! Here's how you can help:

Code of Conduct

Please read and follow our Code of Conduct to foster an inclusive community.

CI/CD Workflow

We use GitHub Actions for continuous integration and deployment:

  • CI Workflow: Automatically runs tests and builds the project on each push and pull request to the main branch.
  • Code Quality: Checks TypeScript compilation to ensure code quality.
  • Release: Publishes the package to npm when a new release is created.

Note: To publish to npm, maintainers need to configure the NPM_TOKEN secret in the repository settings.

How to Contribute

  1. Fork the Repository

    • Create your own fork of the repo

  2. Create a Branch

    • Create a feature branch (git checkout -b feature/amazing-feature)
    • For bug fixes, use (git checkout -b fix/bug-description)

  3. Make Your Changes

    • Follow the code style and conventions
    • Add or update tests as needed
    • Keep your changes focused and related to a single issue

  4. Test Your Changes

    • Ensure all tests pass with npm test
    • Add new tests if appropriate

  5. Commit Your Changes

    • Use clear and descriptive commit messages
    • Reference issue numbers in commit messages when applicable

  6. Submit a Pull Request

    • Provide a clear description of the changes
    • Link any related issues
    • Answer any questions or feedback during review

Creating a CursorRule

To create a CursorRule to make AI agents work more effectively on the codebase:

  1. Visit gitingest.com
  2. Paste the link to the docs folder (e.g., https://github.com/The-Pocket/PocketFlow-Typescript/tree/main/docs) to generate content
  3. Remove the following from the generated result:
    • All utility function files except for llm
    • The design_pattern/multi_agent.md file
    • All _config.yaml and index.md files, except for docs/index.md
  4. Save the result as a CursorRule to help AI agents understand the codebase structure better

Development Setup

# Clone your forked repository
git clone https://github.com/yourusername/PocketFlow-Typescript.git
cd PocketFlow-Typescript

# Install dependencies
npm install

# Run tests
npm test

Reporting Bugs

When reporting bugs, please include:

  • A clear, descriptive title
  • Detailed steps to reproduce the issue
  • Expected and actual behavior
  • Environment information (OS, Node.js version, etc.)
  • Any additional context or screenshots

Community

License

This project is licensed under the MIT License - see the LICENSE file for details.