Skip to content

Commit

Permalink
"backend_dir" -> "comfyui_dir", "BACKEND_DIR" -> "COMFYUI_DIR", "vix_…
Browse files Browse the repository at this point in the history
…backend" -> "ComfyUI"

Signed-off-by: bigcat88 <bigcat88@icloud.com>
  • Loading branch information
bigcat88 committed Nov 28, 2024
1 parent ba19eac commit e2282f5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
18 changes: 9 additions & 9 deletions docs/AdminManual/command_line_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Below are the command-line options related to Visionatrix and ComfyUI.

The following option can be specified for the `install`, `update`, `install-flow`, `orphan-models`, and `openapi` commands:

- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfy_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

## The `run` Command

Starts the ComfyUI and Visionatrix backends.
Starts the Visionatrix.

### Syntax

Expand Down Expand Up @@ -61,7 +61,7 @@ python3 -m visionatrix [--verbose=LEVEL] run [options]

**Note:** The `--verbose` option should be specified **before** any command (e.g., `run`, `install`, `update`).

- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

#### ComfyUI Options

Expand Down Expand Up @@ -189,15 +189,15 @@ python3 -m visionatrix [--verbose=LEVEL] install [options]

### Options

- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

### Example

```shell
python3 -m visionatrix install
```

During installation, you will be prompted to confirm whether to clear flows and backend folders.
During installation, you will be prompted to confirm whether to clear flows and ComfyUI folder.

## The `update` Command

Expand All @@ -211,7 +211,7 @@ python3 -m visionatrix [--verbose=LEVEL] update [options]

### Options

- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

### Example

Expand Down Expand Up @@ -241,7 +241,7 @@ You must specify one of the following options:

Additional options:

- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

### Examples

Expand Down Expand Up @@ -307,7 +307,7 @@ python3 -m visionatrix [--verbose=LEVEL] orphan-models [options]
- `--no-confirm`: Do not ask for confirmation for each model.
- `--dry-run`: Perform cleaning without actually removing models.
- `--include-useful-models`: Include orphaned models that can be used in future flows for removal.
- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

### Example

Expand Down Expand Up @@ -335,7 +335,7 @@ python3 -m visionatrix [--verbose=LEVEL] openapi [options]
- If `--flows` is a comma-separated list of flow names (e.g., `--flows=flow1,flow2`), include those flows.
- `--skip-not-installed`: Skip flows that are not installed. Default: `True`.
- `--exclude-base`: Exclude base application endpoints from OpenAPI specs.
- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--comfyui_dir=COMFYUI_DIR`: Directory for the folder with ComfyUI. Default: `ComfyUI`

### Examples

Expand Down
8 changes: 4 additions & 4 deletions docs/AdminManual/environment_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ VARIABLE_NAME=value

## General Variables

### BACKEND_DIR
### COMFYUI_DIR

- **Description**: Directory for the folder containing ComfyUI. The path can be absolute or relative.
- **Default**: `./vix_backend`
- **Default**: `./ComfyUI`

!!! note

The command-line argument `--backend_dir=BACKEND_DIR` takes precedence over the environment variable.
The command-line argument `--comfyui_dir=COMFYUI_DIR` takes precedence over the environment variable.

### TASKS_FILES_DIR

Expand Down Expand Up @@ -273,7 +273,7 @@ set WORKER_AUTH=worker_user:worker_password
### Starting Visionatrix with Command-Line Arguments

```bash
python3 -m visionatrix run --backend_dir=/path/to/backend --tasks_files_dir=/path/to/tasks_files --ui
python3 -m visionatrix run --comfyui_dir=/path/to/comfyui --tasks_files_dir=/path/to/tasks_files --ui
```

In this example, the directories are specified via command-line arguments, which will override any environment variables or settings in the `.env` file.
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: FAQ
Yes, you can install your Nodes there and run ComfyUI separately. You
can also tell Visionatrix to use ComfyUI installed in a different path.
See the
[\--backend_dir](AdminManual/command_line_options.md#common-options-for-multiple-commands)
[\--comfyui_dir](AdminManual/command_line_options.md#common-options-for-multiple-commands)
parameter.

---
Expand Down

0 comments on commit e2282f5

Please sign in to comment.