Updated readme
This commit is contained in:
@@ -50,7 +50,42 @@ In this example, we're using three `Image Description` nodes to describe the giv
|
||||
|
||||
Install [ComfyUI](https://github.com/comfyanonymous/ComfyUI) using the [instructions](https://github.com/comfyanonymous/ComfyUI?tab=readme-ov-file#installing) for your particular operating system.
|
||||
|
||||
#### 2. Install Griptape-ComfyUI
|
||||
#### 2. Add API Keys to your environment
|
||||
|
||||
Certain API keys are required for various nodes to work. It's recommended to add these to a `.env` file in your base comfyUI folder before you start ComfyUI.
|
||||
|
||||
_Note: Most nodes will work fine with just the `OPENAI_API_KEY`, so at least make sure you have that one._
|
||||
|
||||
```bash
|
||||
OPENAI_API_KEY=
|
||||
GOOGLE_API_KEY=
|
||||
GOOGLE_API_SEARCH_ID=
|
||||
AWS_ACCESS_KEY_ID=
|
||||
AWS_SECRET_ACCESS_KEY=
|
||||
AWS_DEFAULT_REGION=
|
||||
LEONARDO_API_KEY=
|
||||
ANTHROPIC_API_KEY=
|
||||
VOYAGE_API_KEY=
|
||||
GRIPTAPE_API_KEY=
|
||||
```
|
||||
|
||||
You can get the appropriate API keys from these respective sites:
|
||||
|
||||
* OPENAI_API_KEY: https://platform.openai.com/api-keys
|
||||
* GOOGLE_API_KEY: https://makersuite.google.com/app/apikey
|
||||
* AWS_ACCESS_KEY_ID & SECURITY_ACCESS_KEY:
|
||||
* Open the [AWS Console](https://console.aws.amazon.com/)
|
||||
* Click on your username near the top right and select **Security Credentials**
|
||||
* Click on **Users** in the sidebar
|
||||
* Click on your username
|
||||
* Click on the **Security Credentials** tab
|
||||
* Click **Create Access Key**
|
||||
* Click **Show User Security Credentials**
|
||||
* LEONARDO_API_KEY: https://docs.leonardo.ai/docs/create-your-api-key
|
||||
* ANTHROPIC_API_KEY: https://console.anthropic.com/settings/keys
|
||||
* VOYAGE_API_KEY: https://dash.voyageai.com/
|
||||
|
||||
#### 3. Install Griptape-ComfyUI
|
||||
|
||||
There are two methods for installing the Griptape-ComfyUI repository. You can either download or git clone this repository inside the `ComfyUI/custom_nodes`, or use the [ComfyUI Manager](https://github.com/ltdrdata/ComfyUI-Manager).
|
||||
|
||||
@@ -73,13 +108,17 @@ There are two methods for installing the Griptape-ComfyUI repository. You can ei
|
||||
git clone https://github.com/griptape-ai/ComfyUI-Griptape
|
||||
```
|
||||
|
||||
#### 3. Make sure libraries are loaded
|
||||
|
||||
There are required libraries for the ComfyUI-Griptape nodes. They're called out in the requirements.txt file:
|
||||
#### 4. Make sure libraries are loaded
|
||||
|
||||
Libraries should be installed automatically, but if you're having trouble, hopefully this can help.
|
||||
|
||||
There are certain libraries required for Griptape nodes that are called out in the requirements.txt file.
|
||||
|
||||
```bash
|
||||
griptape[all]
|
||||
python-dotenv
|
||||
duckduckgo_search
|
||||
```
|
||||
|
||||
These should get installed automatically if you used the ComfyUI Manager installation method. However, if you're running into issues, please install them yourself either using `pip` or `poetry`, depending on your installation method.
|
||||
@@ -87,46 +126,21 @@ These should get installed automatically if you used the ComfyUI Manager install
|
||||
* Option A - **pip**
|
||||
|
||||
```bash
|
||||
pip install "griptape[all]" python-dotenv
|
||||
pip install "griptape[all]" python-dotenv duckduckgo_search
|
||||
```
|
||||
|
||||
* Option B - **poetry**
|
||||
|
||||
```bash
|
||||
poetry add "griptape[all]" python-dotenv
|
||||
poetry add "griptape[all]" python-dotenv duckduckgo_search
|
||||
```
|
||||
|
||||
#### 4. Add API keys to your Environment
|
||||
#### 5. Restart ComfyUI
|
||||
|
||||
Certain API keys are required for various nodes to work. It's recommended to add these to a `.env` file in your base comfyUI folder before you start ComfyUI.
|
||||
Now if you restart comfyUI, you should see the Griptape menu when you click with the Right Mouse button.
|
||||
|
||||
_Note: Most nodes will work fine with just the `OPENAI_API_KEY`, so at least make sure you have that one._
|
||||
If you don't see the menu, please come to our [Discord](https://discord.gg/fexDeKxf) and let us know what kind of errors you're getting - we would like to resolve them as soon as possible!
|
||||
|
||||
```bash
|
||||
OPENAI_API_KEY=
|
||||
GOOGLE_API_KEY=
|
||||
AWS_ACCESS_KEY_ID=
|
||||
AWS_SECRET_ACCESS_KEY=
|
||||
LEONARDO_API_KEY=
|
||||
ANTHROPIC_API_KEY=
|
||||
VOYAGE_API_KEY=
|
||||
```
|
||||
|
||||
You can get the appropriate API keys from these respective sites:
|
||||
|
||||
* OPENAI_API_KEY: https://platform.openai.com/api-keys
|
||||
* GOOGLE_API_KEY: https://makersuite.google.com/app/apikey
|
||||
* AWS_ACCESS_KEY_ID & SECURITY_ACCESS_KEY:
|
||||
* Open the [AWS Console](https://console.aws.amazon.com/)
|
||||
* Click on your username near the top right and select **Security Credentials**
|
||||
* Click on **Users** in the sidebar
|
||||
* Click on your username
|
||||
* Click on the **Security Credentials** tab
|
||||
* Click **Create Access Key**
|
||||
* Click **Show User Security Credentials**
|
||||
* LEONARDO_API_KEY: https://docs.leonardo.ai/docs/create-your-api-key
|
||||
* ANTHROPIC_API_KEY: https://console.anthropic.com/settings/keys
|
||||
* VOYAGE_API_KEY: https://dash.voyageai.com/
|
||||
|
||||
---
|
||||
|
||||
@@ -134,8 +148,8 @@ You can get the appropriate API keys from these respective sites:
|
||||
|
||||
#### API Keys
|
||||
|
||||
When you run ComfyUI with the Griptape nodes installed, the installation method will check your environment variables and automatically install the appropriate API keys in a file called: `griptape.config.json`.
|
||||
When you run ComfyUI with the Griptape nodes installed, the installation method will check your environment variables and automatically install the appropriate API keys in a file called: `griptape_config.json`.
|
||||
|
||||
If for some reason your environment variables aren't being set properly, you can do this manually by simply copying over the `griptape.config.json.default` file to `griptape.config.json` and add the proper keys there.
|
||||
If for some reason your environment variables aren't being set properly, you can do this manually by simply copying over the `griptape_config.json.default` file to `griptape_config.json` and add the proper keys there.
|
||||
|
||||
If you ever need to change your API keys, go ahead and update that configuration file with the proper key.
|
||||
|
||||
Reference in New Issue
Block a user