Home

Awesome

<h1>Wordflow <a href="https://poloclub.github.io/wordflow/"><picture> <source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/PtyzO16.png"> <img align="right" alt="Wordflow logo." src="public/android-chrome-192x192.png" width="30" height="30"> </picture></a></h1>

Github Actions Status license npm arxiv badge

Social and customizable AI writing assistant tool ✍️

<table> <tr> <td colspan="3"><a href="https://poloclub.github.io/wordflow"><img width="100%" src='https://i.imgur.com/QaWYWni.png'></a></td> </tr> <tr></tr> <tr align="center"> <td><a href="https://poloclub.github.io/wordflow">🚀 Wordflow Demo</a></td> <td><a href="https://youtu.be/3dOcVuofGVo">📺 Demo Video</a></td> <!-- <td><a href="https://youtu.be/l1mr9z1TuAk">👨🏻‍🏫 Conference Talk</a></td> --> <td><a href="https://arxiv.org/abs/2401.14447">📖 Research Paper</a></td> </tr> </table>

What is Wordflow?

Wordflow is a social and customizable AI writing assistant tool! With Wordflow, you can easily write and run AI prompts with different large language models, including both external models (e.g., GPT 4 and Gemini Pro) and local models (e.g., Llama 2 and Phi 2). You can also discover and share your favorite prompts with the community.

<table> <tr> <td>✅</td> <td>Store and run your favorite AI prompts</td> </tr> <tr></tr> <tr> <td>✅</td> <td>Support different external LLMs (e.g., GPT 4 and Gemini Pro)</td> </tr> <tr></tr> <tr> <td>✅</td> <td>Support multiple on-device LLMs (e.g., Llama 2 and Phi 2)</td> </tr> <tr></tr> <tr> <td>✅</td> <td>Powerful customization (e.g., temperature, templates)</td> </tr> <tr></tr> <tr> <td>✅</td> <td>Discover and share community prompts</td> </tr> <tr></tr> <tr></tr> </table>

Features

<img width="100%" src='https://github.com/poloclub/wordflow/assets/15007159/be1ed7df-6a25-477e-aa43-b78d66f53c4d'>

Demo Video

<details> <summary>Click to see the demo video!</summary> <video src="https://github.com/poloclub/wordflow/assets/15007159/276bb179-ec92-4e44-bb65-e796b94506c6"></video> </details>

Get Started

Standalone Version

To use Wordflow, visit: https://poloclub.github.io/wordflow/.

If you use macOS, we highly recommend you creating a Web App using Safari. Open Wordflow in Safari, and then from the menu bar, choose File > Add to Dock.

Note that currently Safari doesn't support WebGPU. If you want to use local LLMs, you can use Chrome to save Wordflow as a Chrome app. In Chrome, at the top right, click More > More Tools > Create shortcut.

<img height="100px" src="https://i.imgur.com/hkGw5zx.png">

Google Doc Add-on

If you use Google Doc, we also provide a Wordflow Add-on that you can install from the Google Workspace Marketplace. The source code of the add-on is in this repository.

Developing Wordflow

Clone or download this repository:

git clone git@github.com:poloclub/wordflow.git

Install the dependencies:

npm install

Then run Wordflow:

npm run dev

Navigate to localhost:3000. You should see Wordflow running in your browser :)

Credits

Wordflow is created by <a href='https://zijie.wang/' target='_blank'>Jay Wang</a>, <a href='https://www.linkedin.com/in/achakrav6' target='_blank'>Aishwarya Chakravarthy</a>, <a href='https://davidmunechika.com/' target='_blank'>David Munechika</a>, and <a href='' target='_blank'>Polo Chau</a>.

Citation

To learn more about Wordflow and social prompt engineering, check out our research paper.

@article{wangWordflowSocialPrompt2024,
  title = {Wordflow: {{Social Prompt Engineering}} for {{Large Language Models}}},
  shorttitle = {Wordflow},
  author = {Wang, Zijie J. and Chakravarthy, Aishwarya and Munechika, David and Chau, Duen Horng},
  year = {2024},
  url = {http://arxiv.org/abs/2401.14447},
  urldate = {2024-01-29},
  archiveprefix = {arxiv},
  journal = {arXiv 2401.14447}
}

License

The software is available under the MIT License.

Contact

If you have any questions, feel free to open an issue or contact Jay Wang.