Skip to content

Commit d27392c

Browse files
Lincoln Steinpsychedelicious
authored andcommitted
remove all references to CLI
1 parent 9fa8e38 commit d27392c

26 files changed

+86
-1059
lines changed

docs/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ sections describe what's new for InvokeAI.
488488

489489
- A choice of installer scripts that automate installation and configuration.
490490
See
491-
[Installation](installation/index.md).
491+
[Installation](installation/INSTALLATION.md).
492492
- A streamlined manual installation process that works for both Conda and
493493
PIP-only installs. See
494494
[Manual Installation](installation/020_INSTALL_MANUAL.md).
@@ -657,7 +657,7 @@ sections describe what's new for InvokeAI.
657657

658658
## v1.13 <small>(3 September 2022)</small>
659659

660-
- Support image variations (see [VARIATIONS](features/VARIATIONS.md)
660+
- Support image variations (see [VARIATIONS](deprecated/VARIATIONS.md)
661661
([Kevin Gibbons](https://github.com/bakkot) and many contributors and
662662
reviewers)
663663
- Supports a Google Colab notebook for a standalone server running on Google
File renamed without changes.

docs/contributing/contribution_guides/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,5 @@ For backend related work, please reach out to **@blessedcoolant**, **@lstein**,
4545

4646
## **What does the Code of Conduct mean for me?**
4747

48-
Our [Code of Conduct](CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.
48+
Our [Code of Conduct](../../CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.
4949

docs/deprecated/CLI.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ Here are the invoke> command that apply to txt2img:
211211
| `--facetool <name>` | `-ft <name>` | `-ft gfpgan` | Select face restoration algorithm to use: gfpgan, codeformer |
212212
| `--codeformer_fidelity` | `-cf <float>` | `0.75` | Used along with CodeFormer. Takes values between 0 and 1. 0 produces high quality but low accuracy. 1 produces high accuracy but low quality |
213213
| `--save_original` | `-save_orig` | `False` | When upscaling or fixing faces, this will cause the original image to be saved rather than replaced. |
214-
| `--variation <float>` | `-v<float>` | `0.0` | Add a bit of noise (0.0=none, 1.0=high) to the image in order to generate a series of variations. Usually used in combination with `-S<seed>` and `-n<int>` to generate a series a riffs on a starting image. See [Variations](../features/VARIATIONS.md). |
215-
| `--with_variations <pattern>` | | `None` | Combine two or more variations. See [Variations](../features/VARIATIONS.md) for now to use this. |
214+
| `--variation <float>` | `-v<float>` | `0.0` | Add a bit of noise (0.0=none, 1.0=high) to the image in order to generate a series of variations. Usually used in combination with `-S<seed>` and `-n<int>` to generate a series a riffs on a starting image. See [Variations](VARIATIONS.md). |
215+
| `--with_variations <pattern>` | | `None` | Combine two or more variations. See [Variations](VARIATIONS.md) for now to use this. |
216216
| `--save_intermediates <n>` | | `None` | Save the image from every nth step into an "intermediates" folder inside the output directory |
217217
| `--h_symmetry_time_pct <float>` | | `None` | Create symmetry along the X axis at the desired percent complete of the generation process. (Must be between 0.0 and 1.0; set to a very small number like 0.0001 for just after the first step of generation.) |
218218
| `--v_symmetry_time_pct <float>` | | `None` | Create symmetry along the Y axis at the desired percent complete of the generation process. (Must be between 0.0 and 1.0; set to a very small number like 0.0001 for just after the first step of generation.) |
File renamed without changes.

docs/features/VARIATIONS.md renamed to docs/deprecated/VARIATIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,6 @@ amounts of image-to-image variation even when the seed is fixed and the
126126
`-v` argument is very low. Others are more deterministic. Feel free to
127127
experiment until you find the combination that you like.
128128

129-
Also be aware of the [Perlin Noise](OTHER.md#thresholding-and-perlin-noise-initialization-options)
129+
Also be aware of the [Perlin Noise](../features/OTHER.md#thresholding-and-perlin-noise-initialization-options)
130130
feature, which provides another way of introducing variability into your
131131
image generation requests.

docs/features/CONCEPTS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ by placing them in the designated directory for the compatible model type
2828

2929
### An Example
3030

31-
Here are a few examples to illustrate how it works. All these images were
32-
generated using the command-line client and the Stable Diffusion 1.5 model:
31+
Here are a few examples to illustrate how it works. All these images
32+
were generated using the legacy command-line client and the Stable
33+
Diffusion 1.5 model:
3334

3435
| Japanese gardener | Japanese gardener &lt;ghibli-face&gt; | Japanese gardener &lt;hoi4-leaders&gt; | Japanese gardener &lt;cartoona-animals&gt; |
3536
| :--------------------------------: | :-----------------------------------: | :------------------------------------: | :----------------------------------------: |

docs/features/CONFIGURATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ format of YAML files can be found
8282
[here](https://circleci.com/blog/what-is-yaml-a-beginner-s-guide/).
8383

8484
You can fix a broken `invokeai.yaml` by deleting it and running the
85-
configuration script again -- option [7] in the launcher, "Re-run the
85+
configuration script again -- option [6] in the launcher, "Re-run the
8686
configure script".
8787

8888
#### Reading Environment Variables

docs/features/CONTROLNET.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Diffuser-style ControlNet models are available at HuggingFace
4646
(http://huggingface.co) and accessed via their repo IDs (identifiers
4747
in the format "author/modelname"). The easiest way to install them is
4848
to use the InvokeAI model installer application. Use the
49-
`invoke.sh`/`invoke.bat` launcher to select item [5] and then navigate
49+
`invoke.sh`/`invoke.bat` launcher to select item [4] and then navigate
5050
to the CONTROLNETS section. Select the models you wish to install and
5151
press "APPLY CHANGES". You may also enter additional HuggingFace
5252
repo_ids in the "Additional models" textbox:
@@ -145,8 +145,8 @@ Additionally, each ControlNet section can be expanded in order to manipulate set
145145
#### Installation
146146
There are several ways to install IP-Adapter models with an existing InvokeAI installation:
147147

148-
1. Through the command line interface launched from the invoke.sh / invoke.bat scripts, option [5] to download models.
149-
2. Through the Model Manager UI with models from the *Tools* section of [www.models.invoke.ai](www.models.invoke.ai). To do this, copy the repo ID from the desired model page, and paste it in the Add Model field of the model manager. **Note** Both the IP-Adapter and the Image Encoder must be installed for IP-Adapter to work. For example, the [SD 1.5 IP-Adapter](https://models.invoke.ai/InvokeAI/ip_adapter_plus_sd15) and [SD1.5 Image Encoder](https://models.invoke.ai/InvokeAI/ip_adapter_sd_image_encoder) must be installed to use IP-Adapter with SD1.5 based models.
148+
1. Through the command line interface launched from the invoke.sh / invoke.bat scripts, option [4] to download models.
149+
2. Through the Model Manager UI with models from the *Tools* section of [www.models.invoke.ai](https://www.models.invoke.ai). To do this, copy the repo ID from the desired model page, and paste it in the Add Model field of the model manager. **Note** Both the IP-Adapter and the Image Encoder must be installed for IP-Adapter to work. For example, the [SD 1.5 IP-Adapter](https://models.invoke.ai/InvokeAI/ip_adapter_plus_sd15) and [SD1.5 Image Encoder](https://models.invoke.ai/InvokeAI/ip_adapter_sd_image_encoder) must be installed to use IP-Adapter with SD1.5 based models.
150150
3. **Advanced -- Not recommended ** Manually downloading the IP-Adapter and Image Encoder files - Image Encoder folders shouid be placed in the `models\any\clip_vision` folders. IP Adapter Model folders should be placed in the relevant `ip-adapter` folder of relevant base model folder of Invoke root directory. For example, for the SDXL IP-Adapter, files should be added to the `model/sdxl/ip_adapter/` folder.
151151

152152
#### Using IP-Adapter

docs/features/MODEL_MERGING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ Model Merging can be be done by navigating to the Model Manager and clicking the
1616
display all the diffusers-style models that InvokeAI knows about.
1717
If you do not see the model you are looking for, then it is probably
1818
a legacy checkpoint model and needs to be converted using the
19-
`invoke` command-line client and its `!optimize` command. You
20-
must select at least two models to merge. The third can be left at
21-
"None" if you desire.
19+
"Convert" option in the Web-based Model Manager tab.
20+
21+
You must select at least two models to merge. The third can be left
22+
at "None" if you desire.
2223

2324
* Alpha: This is the ratio to use when combining models. It ranges
2425
from 0 to 1. The higher the value, the more weight is given to the

docs/features/UTILITIES.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Command-line Utilities
88

99
InvokeAI comes with several scripts that are accessible via the
1010
command line. To access these commands, start the "developer's
11-
console" from the launcher (`invoke.bat` menu item [8]). Users who are
11+
console" from the launcher (`invoke.bat` menu item [7]). Users who are
1212
familiar with Python can alternatively activate InvokeAI's virtual
1313
environment (typically, but not necessarily `invokeai/.venv`).
1414

@@ -34,7 +34,7 @@ invokeai-web --ram 7
3434

3535
## **invokeai-merge**
3636

37-
This is the model merge script, the same as launcher option [4]. Call
37+
This is the model merge script, the same as launcher option [3]. Call
3838
it with the `--gui` command-line argument to start the interactive
3939
console-based GUI. Alternatively, you can run it non-interactively
4040
using command-line arguments as illustrated in the example below which
@@ -48,7 +48,7 @@ invokeai-merge --force --base-model sd-1 --models stable-diffusion-1.5 inkdiffus
4848
## **invokeai-ti**
4949

5050
This is the textual inversion training script that is run by launcher
51-
option [3]. Call it with `--gui` to run the interactive console-based
51+
option [2]. Call it with `--gui` to run the interactive console-based
5252
front end. It can also be run non-interactively. It has about a
5353
zillion arguments, but a typical training session can be launched
5454
with:
@@ -68,7 +68,7 @@ in Windows).
6868
## **invokeai-install**
6969

7070
This is the console-based model install script that is run by launcher
71-
option [5]. If called without arguments, it will launch the
71+
option [4]. If called without arguments, it will launch the
7272
interactive console-based interface. It can also be used
7373
non-interactively to list, add and remove models as shown by these
7474
examples:
@@ -148,7 +148,7 @@ launch the web server against it with `invokeai-web --root InvokeAI-New`.
148148
## **invokeai-update**
149149

150150
This is the interactive console-based script that is run by launcher
151-
menu item [9] to update to a new version of InvokeAI. It takes no
151+
menu item [8] to update to a new version of InvokeAI. It takes no
152152
command-line arguments.
153153

154154
## **invokeai-metadata**

docs/features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Learn how to install and use ControlNet models for fine control over
2828
image output.
2929

3030
### * [Image-to-Image Guide](IMG2IMG.md)
31-
Use a seed image to build new creations in the CLI.
31+
Use a seed image to build new creations.
3232

3333
## Model Management
3434

docs/index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ Mac and Linux machines, and runs on GPU cards with as little as 4 GB of RAM.
143143
<!-- seperator -->
144144
### Prompt Engineering
145145
- [Prompt Syntax](features/PROMPTS.md)
146-
- [Generating Variations](features/VARIATIONS.md)
147146

148147
### InvokeAI Configuration
149148
- [Guide to InvokeAI Runtime Settings](features/CONFIGURATION.md)
@@ -166,10 +165,8 @@ still a work in progress, but coming soon.
166165

167166
### Command-Line Interface Retired
168167

169-
The original "invokeai" command-line interface has been retired. The
170-
`invokeai` command will now launch a new command-line client that can
171-
be used by developers to create and test nodes. It is not intended to
172-
be used for routine image generation or manipulation.
168+
All "invokeai" command-line interfaces have been retired as of version
169+
3.4.
173170

174171
To launch the Web GUI from the command-line, use the command
175172
`invokeai-web` rather than the traditional `invokeai --web`.

docs/installation/050_INSTALLING_MODELS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ InvokeAI root directory's `autoimport` folder.
8484

8585
### Installation via `invokeai-model-install`
8686

87-
From the `invoke` launcher, choose option [5] "Download and install
87+
From the `invoke` launcher, choose option [4] "Download and install
8888
models." This will launch the same script that prompted you to select
8989
models at install time. You can use this to add models that you
9090
skipped the first time around. It is all right to specify a model that

docs/installation/deprecated_documentation/INSTALL_LINUX.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ title: Manual Installation, Linux
7979
and obtaining an access token for downloading. It will then download and
8080
install the weights files for you.
8181

82-
Please look [here](../INSTALL_MANUAL.md) for a manual process for doing
82+
Please look [here](../020_INSTALL_MANUAL.md) for a manual process for doing
8383
the same thing.
8484

8585
7. Start generating images!
@@ -112,7 +112,7 @@ title: Manual Installation, Linux
112112
To use an alternative model you may invoke the `!switch` command in
113113
the CLI, or pass `--model <model_name>` during `invoke.py` launch for
114114
either the CLI or the Web UI. See [Command Line
115-
Client](../../features/CLI.md#model-selection-and-importation). The
115+
Client](../../deprecated/CLI.md#model-selection-and-importation). The
116116
model names are defined in `configs/models.yaml`.
117117

118118
8. Subsequently, to relaunch the script, be sure to run "conda activate

docs/installation/deprecated_documentation/INSTALL_MAC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ will do our best to help.
150150
To use an alternative model you may invoke the `!switch` command in
151151
the CLI, or pass `--model <model_name>` during `invoke.py` launch for
152152
either the CLI or the Web UI. See [Command Line
153-
Client](../../features/CLI.md#model-selection-and-importation). The
153+
Client](../../deprecated/CLI.md#model-selection-and-importation). The
154154
model names are defined in `configs/models.yaml`.
155155

156156
---

docs/installation/deprecated_documentation/INSTALL_SOURCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ python scripts/invoke.py --web --max_load_models=3 \
128128
```
129129

130130
These options are described in detail in the
131-
[Command-Line Interface](../../features/CLI.md) documentation.
131+
[Command-Line Interface](../../deprecated/CLI.md) documentation.
132132

133133
## Troubleshooting
134134

docs/installation/deprecated_documentation/INSTALL_WINDOWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
7575
obtaining an access token for downloading. It will then download and install the
7676
weights files for you.
7777
78-
Please look [here](../INSTALL_MANUAL.md) for a manual process for doing the
78+
Please look [here](../020_INSTALL_MANUAL.md) for a manual process for doing the
7979
same thing.
8080
8181
8. Start generating images!
@@ -108,7 +108,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
108108
To use an alternative model you may invoke the `!switch` command in
109109
the CLI, or pass `--model <model_name>` during `invoke.py` launch for
110110
either the CLI or the Web UI. See [Command Line
111-
Client](../../features/CLI.md#model-selection-and-importation). The
111+
Client](../../deprecated/CLI.md#model-selection-and-importation). The
112112
model names are defined in `configs/models.yaml`.
113113
114114
9. Subsequently, to relaunch the script, first activate the Anaconda

installer/templates/invoke.bat.in

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,41 +9,37 @@ set INVOKEAI_ROOT=.
99
:start
1010
echo Desired action:
1111
echo 1. Generate images with the browser-based interface
12-
echo 2. Explore InvokeAI nodes using a command-line interface
13-
echo 3. Run textual inversion training
14-
echo 4. Merge models (diffusers type only)
15-
echo 5. Download and install models
16-
echo 6. Change InvokeAI startup options
17-
echo 7. Re-run the configure script to fix a broken install or to complete a major upgrade
18-
echo 8. Open the developer console
19-
echo 9. Update InvokeAI
20-
echo 10. Run the InvokeAI image database maintenance script
21-
echo 11. Command-line help
12+
echo 2. Run textual inversion training
13+
echo 3. Merge models (diffusers type only)
14+
echo 4. Download and install models
15+
echo 5. Change InvokeAI startup options
16+
echo 6. Re-run the configure script to fix a broken install or to complete a major upgrade
17+
echo 7. Open the developer console
18+
echo 8. Update InvokeAI
19+
echo 9. Run the InvokeAI image database maintenance script
20+
echo 10. Command-line help
2221
echo Q - Quit
23-
set /P choice="Please enter 1-11, Q: [1] "
22+
set /P choice="Please enter 1-10, Q: [1] "
2423
if not defined choice set choice=1
2524
IF /I "%choice%" == "1" (
2625
echo Starting the InvokeAI browser-based UI..
2726
python .venv\Scripts\invokeai-web.exe %*
2827
) ELSE IF /I "%choice%" == "2" (
29-
echo Starting the InvokeAI command-line..
30-
python .venv\Scripts\invokeai.exe %*
31-
) ELSE IF /I "%choice%" == "3" (
3228
echo Starting textual inversion training..
3329
python .venv\Scripts\invokeai-ti.exe --gui
34-
) ELSE IF /I "%choice%" == "4" (
30+
) ELSE IF /I "%choice%" == "3" (
3531
echo Starting model merging script..
3632
python .venv\Scripts\invokeai-merge.exe --gui
37-
) ELSE IF /I "%choice%" == "5" (
33+
) ELSE IF /I "%choice%" == "4" (
3834
echo Running invokeai-model-install...
3935
python .venv\Scripts\invokeai-model-install.exe
40-
) ELSE IF /I "%choice%" == "6" (
36+
) ELSE IF /I "%choice%" == "5" (
4137
echo Running invokeai-configure...
4238
python .venv\Scripts\invokeai-configure.exe --skip-sd-weight --skip-support-models
43-
) ELSE IF /I "%choice%" == "7" (
39+
) ELSE IF /I "%choice%" == "6" (
4440
echo Running invokeai-configure...
4541
python .venv\Scripts\invokeai-configure.exe --yes --skip-sd-weight
46-
) ELSE IF /I "%choice%" == "8" (
42+
) ELSE IF /I "%choice%" == "7" (
4743
echo Developer Console
4844
echo Python command is:
4945
where python
@@ -55,13 +51,13 @@ IF /I "%choice%" == "1" (
5551
echo *************************
5652
echo *** Type `exit` to quit this shell and deactivate the Python virtual environment ***
5753
call cmd /k
58-
) ELSE IF /I "%choice%" == "9" (
54+
) ELSE IF /I "%choice%" == "8" (
5955
echo Running invokeai-update...
6056
python -m invokeai.frontend.install.invokeai_update
61-
) ELSE IF /I "%choice%" == "10" (
57+
) ELSE IF /I "%choice%" == "9" (
6258
echo Running the db maintenance script...
6359
python .venv\Scripts\invokeai-db-maintenance.exe
64-
) ELSE IF /I "%choice%" == "11" (
60+
) ELSE IF /I "%choice%" == "10" (
6561
echo Displaying command line help...
6662
python .venv\Scripts\invokeai-web.exe --help %*
6763
pause

0 commit comments

Comments
 (0)