flowgen

# flowgen
flowgen is an open-source tool that turns plain text into beautiful, structured flowcharts.  Designed for developers, writers, and technical communicators, flowgen lets you express logic, processes, or ideas in simple, readable text—and automatically converts it into flow diagrams.

## Requirements
- Node.js 14 or higher
- Chrome or Chromium-based browser (for rendering) 
- Mermaid.js library (see below)
- At least one of these two (`cli` mode or `mcp` mode)
    - CLI LLM configuration (see below)
    - MCP server (see below)

### Mermaid Installation
Using `npm`: `npm install` (under project root directory). (Installing `Mermaid` via `yarn` is not recommended. )

### Additional Requirements for CLI 

Add your LLM API key:
It can be any LLM(OpenAI, Anthropic, Ollama etc.) as long as it supports the OpenAI API.
```sh
export LLM_API_KEY="your_llm_api_key"
export LLM_BASE_URL="your_llm_base_url"
export LLM_MODEL="your_llm_model"
```
Or you can create a .env file in the root directory and add the following:
```sh
LLM_API_KEY="your_llm_api_key"
LLM_BASE_URL="your_llm_base_url" # e.g. https://api.openai.com/v1
LLM_MODEL="your_llm_model" # e.g. gpt-4o
AZURE_API_VERSION="your_azure_api_version" # optional, only for Azure OpenAI e.g. 2024-12-01-preview
```


### Additional Requirements for MCP Server

To use the MCP server functionality, you'll need:

- An MCP client such as Claude Desktop ([download here](https://claude.ai/download))
- A valid MCP configuration file:
  - For Claude Desktop users: Follow the [setup instructions](https://modelcontextprotocol.io/quickstart/user) to create your `claude_desktop_config.json`
  - For other MCP clients: Refer to your client's documentation for configuration details.

## Quick Start (without MCP)

1. Run the Build Process:
```sh
npm run build
npm link
```

2. Run flowgen via command line:
```sh
flowgen "[your prompt here. For example: design and generate a flowchart of Yelp, simple version. ]"
```
It will genenerate a output.png file in the current directory.

## Quick Start with MCP Server
1. Run the Build Process:
```sh
npm run build
```
2. Open the config file (such as `claude_desktop_config.json`) and add the following configuration:
```json
{
    "mcpServers": {
        "filesystem": {
        "command": "npx",
        "args": [
            "-y",
            "@modelcontextprotocol/server-filesystem",
            "[PATH TO PARENT FOLDER]/flowgen"
            ]
        },
        "flowgen": {
            "command": "node",
            "args": [
                "[PATH TO PARENT FOLDER]/flowgen/build/index.js"
            ]
        }
    }
}
```

3. Restart the MCP client. Now the MCP tooling should be available in the client.

4. Run flowgen via MCP client; same as above (without MCP server).