stable-diffusion-prompt-reader

[!TIP] The SD Prompt Reader is now available as a ComfyUI node. Check out the ComfyUI Prompt Reader Node for more information.

Features

• Support macOS, Windows and Linux.
• Provides both GUI and CLI
• Simple drag and drop interaction.
• Copy prompt to clipboard.
• Remove prompt from image.
• Export prompt to text file.
• Edit or import prompt to images
• Vertical orientation display and sorting by alphabet
• Detect generation tool.
• Multiple formats support.
• Dark and light mode support.

Supported Formats

	PNG	JPEG	WEBP	TXT*
A1111's webUI	✅	✅	✅	✅
Easy Diffusion	✅	✅	✅
StableSwarmUI*	✅	✅
StableSwarmUI (prior to 0.5.8-alpha)*	✅	✅
Fooocus-MRE*	✅	✅
NovelAI (stealth pnginfo)	✅		✅
NovelAI (legacy)	✅
InvokeAI	✅
InvokeAI (prior to 2.3.5-post.2)	✅
InvokeAI (prior to 1.15)	✅
ComfyUI*	✅
Draw Things	✅
Naifu(4chan)	✅

* Limitations apply. See format limitations.

[!NOTE] If you are using a tool or format that is not on this list, please help me to support your format by uploading the original file generated by your tool to the issues, thx.

[!TIP] For ComfyUI users, the SD Prompt Reader is now available as a ComfyUI node. The ComfyUI Prompt Reader Node is a subproject of this project, and it is recommended to embed the Prompt Saver node in the ComfyUI Prompt Reader Node within your workflow to ensure maximum compatibility.

Download

For Windows users

Download executable from GitHub Releases

For macOS users

Download executable from GitHub Releases

Install via Homebrew Cask

You may also install SD Prompt Reader via Homebrew cask.

brew install --no-quarantine receyuki/sd-prompt-reader/sd-prompt-reader

The parameter --no-quarantine is used since the SD Prompt Reader is currently unsigned as I mentioned here

For Linux users (not regularly tested)

I'm pretty sure linux users can figure things out without an executable.

• The minimum version of Python required is 3.10
• Make sure you have the tkinter package installed in your Python.
  If not, install the python3-tk package with package managers.
  e.g. sudo apt-get install python3-tk for Debian-based distributions

You can choose to install with pip or run it manually

Install with pip or pipx

pip install sd-prompt-reader

or

pipx install sd-prompt-reader

To launch the GUI just enter sd-prompt-reader in the terminal.
For the CLI, please use sd-prompt-reader-cli.

Run source code manually

1. Clone this repo.

   git clone https://github.com/receyuki/stable-diffusion-prompt-reader.git
   

   or download repo as a zip.
2. CD to the directory and install dependencies.

   cd stable-diffusion-prompt-reader  
   pip install -r requirements.txt
   

3. Run.

   python -m sd_prompt_reader.app
   

Usage

Read prompt

• Open the executable file (.exe or .app) and drag and drop the image into the window.

OR

• Right click on the image and select open with SD Prompt Reader

OR

• Drag and drop the image directly onto executable (.exe or .app).

Export prompt to a text file

• Click "Export" will generate a txt file alongside the image file.
• To save to another location, click the expand arrow and click "select directory".

Remove prompt from image

• Click "Clear" will generate a new image file with suffix "_data_removed" alongside the original image file.
• To save to another location, click the expand arrow and click "select directory".
• To overwrite the original image file, click the expand arrow and click "overwrite the original image".

Edit image

[!NOTE] The edited image will be written in A1111 format, meaning that image in any format will become A1111 format after editing.

• Click "Edit" to enter edit mode.
• Edit the prompt directly in the textbox or import a metadata file in txt format.
• Click "Save" will generate a edited image file with suffix "_edited" alongside the original image file.
• To save to another location, click the expand arrow and click "select directory".
• To overwrite the original image file, click the expand arrow and click "overwrite the original image".

Copy as single line prompt

Copy image prompt and setting in a format that can be read by Prompts from file or textbox The following parameters are supported:

Setting	Parameter
Seed	--seed
Variation seed strength	--subseed_strength
Seed resize from	--seed_resize_from_h
Seed resize from	--seed_resize_from_w
Sampler	--sampler_name
Steps	--steps
CFG scale	--cfg_scale
Size	--width
Size	--height
Face restoration	--restore_faces

• Click the expand arrow and click "single line prompt".
• Paste it into the textbox below the webui script "Prompts from file or textbox".

ComfyUI SDXL workflow

[!NOTE] The SDXL workflow does not support editing. If necessary, please remove prompts from image before edit.

If the image's workflow includes multiple sets of SDXL prompts, namely Clip G(text_g), Clip L(text_l), and Refiner, the SD Prompt Reader will switch to the multi-set prompt display mode as shown in the image below. There are two interface options available for the multi-set prompt display mode, and you can switch between them using buttons.

CLI

A CLI tool for reading, modifying, and clearing metadata is provided.

Platforms

For Windows users

SD Prompt Reader CLI.exe will be placed in the zip package as a separate executable.
Examples: "SD Prompt Reader CLI.exe" -i example.png

For macOS users

The executable is located at SD Prompt Reader.app/Contents/MacOS/SD Prompt Reader.
Examples: /Applications/SD\ Prompt\ Reader.app/Contents/MacOS/SD\ Prompt\ Reader -i example.png

For pip users

Examples: sd-prompt-reader-cli -i example.png

Modes and Options

Modes

• Read Mode: Activated by -r or --read flag.
• Write Mode: Activated by -w or --write flag.
• Clear Mode: Activated by -c or --clear flag.

General Options

• -i, --input-path: Path to the input image file or directory containing image files, required parameter.
• -o, --output-path: Path to the output file or directory where the processed files will be saved.
• -l, --log-level: Specify the log verbosity level (e.g.DEBUG, INFO, WARN, ERROR).

Read Options

• -f, --format-type: Specifies the output metadata format, choices are "TXT" or "JSON". Default format is "TXT"

Write Options

• -m, --metadata: Provides a metadata file for writing.
• -p, --positive: Provides a positive prompt string for writing.
• -n, --negative: Provides a negative prompt string for writing.
• -s, --setting: Provides a setting string for writing.

Basic Usage

• If no output path is specified, the modified image will be saved in the current directory with a suffix added to the original filename.
• To overwrite the source file, set the output path equal to the input path.
• The write mode only supports modifications to a single image.

Read Mode

• Read metadata from an image.
• Usage:
  sd-prompt-reader-cli [-r] -i [--format-type ] [-o ]
• Examples:
  sd-prompt-reader-cli -i example.png
sd-prompt-reader-cli -i example.png -o metadata.txt
sd-prompt-reader-cli -r -i example.png -f TXT -o output_folder/
sd-prompt-reader-cli -r -i input_folder/ -f JSON -o output_folder/

Write Mode

• Write metadata to an image.
• Usage:
  sd-prompt-reader-cli -w -i -m [-o ]
• Examples:
  sd-prompt-reader-cli -w -i example.png -m new_metadata.txt
sd-prompt-reader-cli -w -i example.png -m new_metadata.txt -o output.png
sd-prompt-reader-cli -w -i example.png -m new_metadata.json -o output_folder/

Clear Mode

• Remove all metadata from an image.
• Usage:
  sd-prompt-reader-cli -c -i [-o ]
• Examples:
  sd-prompt-reader-cli -c -i example.png
sd-prompt-reader-cli -c -i example.png -o output.png
sd-prompt-reader-cli -c -i example.png -o output_folder/
sd-prompt-reader-cli -c -i input_folder/ -o output_folder/

Format Limitations

TXT

1. Importing txt file is only allowed in edit mode.
2. Only A1111 format txt files are supported. You can use txt files generated by the A1111 webui or use the SD prompt reader to export txt from A1111 images

StableSwarmUI

[!IMPORTANT] StableSwarmUI is still in the Alpha testing phase, and its format may change in the future. I will keep track of upcoming updates of StableSwarmUI.

ComfyUI

[!IMPORTANT] When custom nodes are used or when the workflow becomes overly complex, there is a high probability that metadata may not be correctly read. This is because ComfyUI does not store metadata but only the complete workflow. SD Prompt Reader can only handle basic workflows. It is recommended to embed the Prompt Saver node in the ComfyUI Prompt Reader Node within your workflow to ensure maximum compatibility.

1. If there are multiple sets of data (seed, steps, CFG, etc.) in the setting box, this means that there are multiple KSampler nodes in the flowchart.
2. Due to the nature of ComfyUI, all nodes and flowcharts in the workflow are stored in the image, including those that are not being used. Also, a flowchart can have multiple branches, inputs and outputs. (e.g. output hires. fixed image and original image simultaneously in a single flow