Initial Set Up

​

Install dev tools

1. Install Python to version 3.12 or greater
   Install Python here: https://www.python.org/about/gettingstarted/
2. (Optional, but recommended) Setup VSCode to run WorkflowAI
   1. Install VSCode. You can use another code editor however please note that some functionality may be limited for the time being.
   2. Install code command line to use VSCode to edit data
      1. Open VSCode
      2. Type cmd + shift + p
      3. Search for and select Install ‘code’ command in PATH

​

Clone and navigate to the repo

4. Clone the WorkflowAI repo.
   1. If using the CLI, you can type: gh repo clone workflow-ai/workflowai

5. Once you’ve cloned the repo, navigate to the directory of the repo on your computer.
   1. example cd exampleUser/exampleFolder/workflowai

​

Create a virtual environment

6. Create a virtual environment. In the terminal type:
   1. python -m venv .venv
   2. source .venv/bin/activate
   3. make install

​

Login to workflowAI

7. In the terminal type:
   1. workflowai start
   2. When asked if you want to log in, press y
   3. Copy the token on the browser and paste it into the terminal (you will not see it in the terminal but it will be there) and press enter
   4. When prompted, copy and paste your Open AI API key into terminal and press enter. .
      You can get your OpenAI API key here