cmfy 0.3.0

A CLI companion app for Comfy UI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# cmfy

[![Build](https://github.com/meuter/cmfy-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/meuter/cmfy-rs/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/cmfy)](https://crates.io/crates/cmfy)
[![Docs.rs](https://docs.rs/cmfy/badge.svg)](https://docs.rs/cmfy)
[![Crates.io](https://img.shields.io/crates/d/cmfy)](https://crates.io/crates/cmfy)
[![Crates.io](https://img.shields.io/crates/l/cmfy)](https://github.com/meuter/cmfy/blob/main/LICENSE)

A CLI companion app for Comfy UI

## Usage

`cmfy` provides several commands:

```
Usage: cmfy [OPTIONS] <COMMAND>

Commands:
  stats    Displays basic statistics about client and server
  history  Manipulates history of prompts
  queue    Manipulates the queue of pending prompts
  list     List all prompts from history and queue
  cancel   Cancel currently running prompt
  clear    Clear all prompts from history, queue and currently running prompt
  open     Open ComfyUI in a web browser
  capture  Capture running and pending prompt to file
  submit   Submits a batch of prompts to the server
  view     Open images from completed prompts in a browser
  get      Display GET request raw json output
  listen   Opens a websocket connection to the server, listens for messages and displays them as JSON on the console
  extract  Extracts prompt information from a PNG generated with Comfy UI, and outputs it as JSON
  help     Print this message or the help of the given subcommand(s)

Options:
  -s, --hostname <HOSTNAME>  hostname of the server [env: COMFY_HOSTNAME=172.24.80.1] [default: localhost]
  -p, --port <PORT>          port of the server [env: COMFY_PORT=] [default: 8188]
  -h, --help                 Print help
  -V, --version              Print version
```

## Installation

### From crates.io

- Install rust as per [these instructions](https://www.rust-lang.org/tools/install)
- Install `cmfy`:
  ```
  cargo install cmfy
  ```

### From source

- Install rust as per [these instructions](https://www.rust-lang.org/tools/install)
- Clone the repo:
  ```
  git clone https://github.com/meuter/cmfy
  ```
- Install `cmfy`:
  ```
  cd cmfy
  cargo install --path .
  ```

### From Github Release

- Download the prebuilt binaries from the [release](https://github.com/meuter/cmfy-rs/releases) page.