Skip to content

Commit

Permalink
Write Work with Terminal page.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nourepide committed Nov 30, 2023
1 parent c440333 commit 7386ad9
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 35 deletions.
3 changes: 2 additions & 1 deletion Writerside/allor-doc.tree
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<toc-element topic="Introducing.md"/>
<toc-element toc-title="Installation">
<toc-element topic="Work-with-Terminal.md" hidden="true"/>
<toc-element topic="Installation-ComfyUI.md"/>
<toc-element topic="Installation-Allor.md"/>
</toc-element>
Expand Down Expand Up @@ -134,5 +135,5 @@
<toc-element topic="Clamp-Vae.md"/>
</toc-element>
</toc-element>
<toc-element topic="FAQ.md"/>
<toc-element topic="FAQ.md"/>
</instance-profile>
14 changes: 4 additions & 10 deletions Writerside/topics/Installation-Allor.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) insta

<procedure>

1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory.
See how to [Work with Terminal](Work-with-Terminal.md).

You can do this by opening the Terminal and using the `cd` command.
1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory.

2. **Clone the Repository**: Clone the repository by entering the following command:

Expand Down Expand Up @@ -88,15 +88,9 @@ If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) insta

<procedure>

1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder.

You can do this by pressing <shortcut>Win+R</shortcut> and typing `cmd`.

To change the drive, type the letter of the desired drive followed by a colon.
For example, `D:` will switch you to the D drive.
See how to [Work with Terminal](Work-with-Terminal.md).

To move to another folder, use the cd command followed by the folder path.
For example, `cd ComfyUI` will take you to the ComfyUI folder.
1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder.

2. **Clone the Repository**: Clone the repository by entering the following command:

Expand Down
36 changes: 12 additions & 24 deletions Writerside/topics/Installation-ComfyUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ This will prevent a system **pollution**, eliminate **dependency conflicts**, an

<procedure>

1. **Open Terminal**: Navigate to the `ComfyUI` root directory.
See how to [Work with Terminal](Work-with-Terminal.md).

You can do this by opening the Terminal and using the `cd` command.
1. **Open Terminal**: Navigate to the `ComfyUI` root directory.

2. **Create Virtual Environment**: You can do it by typing the following command.
```Bash
Expand All @@ -116,15 +116,9 @@ This will prevent a system **pollution**, eliminate **dependency conflicts**, an

<procedure>

1. **Open Command Prompt**: Navigate to the `ComfyUI` root folder.

You can do this by pressing <shortcut>Win+R</shortcut> and typing `cmd`.
See how to [Work with Terminal](Work-with-Terminal.md).

To change the drive, type the letter of the desired drive followed by a colon.
For example, `D:` will switch you to the D drive.

To move to another folder, use the cd command followed by the folder path.
For example, `cd ComfyUI` will take you to the ComfyUI folder.
1. **Open Command Prompt**: Navigate to the `ComfyUI` root folder.

2. **Create Virtual Environment**: You can do it by typing the following command.
```Bash
Expand Down Expand Up @@ -162,11 +156,9 @@ One of the most important steps in installing **ComfyUI** is installing **depend
<procedure>
1. **Open Terminal**: Navigate to the `ComfyUI` root directory.
You can do this by opening the Terminal and using the `cd` command.
See how to [Work with Terminal](Work-with-Terminal.md).
You can **skip** this step if you have setup a **virtual environment**.
1. **Open Terminal**: Navigate to the `ComfyUI` root directory.
2. **Install PyTorch Dependencies**:
* **For AMD**:
Expand Down Expand Up @@ -197,17 +189,9 @@ One of the most important steps in installing **ComfyUI** is installing **depend
<procedure>
1. **Open Command Prompt**: Navigate to the `ComfyUI` root folder.
You can do this by pressing <shortcut>Win+R</shortcut> and typing `cmd`.
To change the drive, type the letter of the desired drive followed by a colon.
For example, `D:` will switch you to the D drive.
See how to [Work with Terminal](Work-with-Terminal.md).
To move to another folder, use the cd command followed by the folder path.
For example, `cd ComfyUI` will take you to the ComfyUI folder.
You can **skip** this step if you have setup a **virtual environment**.
1. **Open Command Prompt**: Navigate to the `ComfyUI` root folder.
2. **Install PyTorch Dependencies**:
* **For AMD**:
Expand Down Expand Up @@ -239,6 +223,8 @@ The hardest part is behind, now you can launch **ComfyUI** and start generating
<procedure>
See how to [Work with Terminal](Work-with-Terminal.md).
1. **Type into Terminal**: Now you can finally run **ComfyUI** by following command.
* **Run on Linux**:
```Bash
Expand Down Expand Up @@ -278,6 +264,8 @@ The hardest part is behind, now you can launch **ComfyUI** and start generating
<procedure>
See how to [Work with Terminal](Work-with-Terminal.md).
1. **Open Command Prompt**: Now you can finally run **ComfyUI** by following command.
* **Run on AMD**:
```Bash
Expand Down
161 changes: 161 additions & 0 deletions Writerside/topics/Work-with-Terminal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# Work with Terminal

At many stages with the installation of **ComfyUI** and **Allor** you will have to interact with the **terminal**
frequently, here you can learn how to use it.

If you are not yet familiar with the terminal or have never used it, you should realize one thing.

A **terminal** is simply a program that allows users to interact with a system using text commands. And a system is primarily a set of files.

For your convenience, you can think of it as a **file manager**.

<tabs group="installing">
<tab title="Unix Terminal" group-key="unix">

<procedure>

On **Unix** systems, opening a **terminal** can vary greatly depending on the **graphical environment** and the default packages supplied in the **distributions**.

* **macOS**: Pressing <shortcut>Cmd + Space</shortcut> opens **Spotlight Search**, where you can start typing `Terminal` and press <shortcut>Enter</shortcut>.
* **KDE**: Pressing <shortcut>Alt + F2</shortcut> opens the **Run Command** dialog where you can type `konsole` and press <shortcut>Enter</shortcut>.
* **Gnome**: Pressing <shortcut>Alt + F2</shortcut> opens the **Run Command** dialog where you can type `gnome-terminal` and press <shortcut>Enter</shortcut>.
* **Linux**: In most Linux graphical environments, pressing <shortcut>Ctrl + Alt + T</shortcut> will open the default terminal.

But as a rule, this does not cause any difficulty.

</procedure>

</tab>
<tab title="Windows Command Prompt" group-key="windows">

<procedure>

On **Windows** systems, you can open the **Command Prompt** in several ways. The **last two** are **preferred**.

- **With Start menu**: Click the **Start** button, then start typing `cmd` or **Command line**.

- **With Run dialog**: Press the <shortcut>Win+R</shortcut> key combination to open the **Run** dialog. Type `cmd` and press <shortcut>Enter</shortcut>.

- **With Explorer**: Navigate to the folder you need, then type `cmd` in the address bar and press <shortcut>Enter</shortcut>. This will open the command line with the current directory set to the folder you selected.

- **With context menu**: In **Explorer**, you can <shortcut>Right-Click + Shift</shortcut> and select <shortcut>Open command window here</shortcut> or <shortcut>Open PowerShell window here</shortcut> (depending on the version of Windows).

Also, you do not need to run the terminal with administrator rights during the installation of **ComfyUI** or **Allor**.

</procedure>

</tab>
</tabs>

Now it's time to learn a few little commands that we will be working with when installing **ComfyUI** and **Allor**.

<tabs group="installing">
<tab title="Unix Terminal" group-key="unix">

<procedure>

<deflist>
<def title="pwd">
Show you your current directory
</def>
<def title="ls">
Show all files and directories in current place
</def>
<def title="cd dir_name">
Change directory to <control>dir_name</control>
</def>
<def title="cd ..">
Change directory to <control>upper level</control>
</def>
<def title="Pressing Tab">
Autocomplete, such as <control>Com -> ComfyUI_windows_portable</control>
</def>
</deflist>

</procedure>

</tab>
<tab title="Windows Command Prompt" group-key="windows">

<procedure>

<deflist>
<def title="cd">
Show you your current directory
</def>
<def title="dir">
Show all files and directories in current place
</def>
<def title="A:">
Change current disk to A
</def>
<def title="cd dir_name">
Change directory to <control>dir_name</control>
</def>
<def title="cd ..">
Change directory to <control>upper level</control>
</def>
<def title="Pressing Tab">
Autocomplete, such as <control>Com -> ComfyUI_windows_portable</control>
</def>
</deflist>

</procedure>

</tab>
</tabs>

And a couple more commands that you probably won't need during installation, but will be useful to know.

<tabs group="installing">
<tab title="Unix Terminal" group-key="unix">

<procedure>

<deflist>
<def title="mkdir dir_name">
Create a new directory <control>dir_name</control>
</def>
<def title="rm file_name">
Remove file <control>file_name</control>
</def>
<def title="rm -r dir_name">
Remove directory <control>dir_name</control>
</def>
<def title="mv file_name new_file_name">
Rename file or directory from <control>file_name</control> to <control>new_file_name</control>
</def>
<def title="mv file_name ..\file_name">
Move file or directory from current place to upper
</def>
</deflist>

</procedure>

</tab>
<tab title="Windows Command Prompt" group-key="windows">

<procedure>

<deflist>
<def title="mkdir dir_name">
Create a new directory <control>dir_name</control>
</def>
<def title="rm file_name">
Remove file <control>file_name</control>
</def>
<def title="rd \s dir_name">
Remove directory <control>dir_name</control>
</def>
<def title="ren file_name new_file_name">
Rename file or directory from <control>file_name</control> to <control>new_file_name</control>
</def>
<def title="move file_name ..\">
Move file or directory from current place to upper
</def>
</deflist>

</procedure>

</tab>
</tabs>

0 comments on commit 7386ad9

Please sign in to comment.