Skip to content

Commit cd3df1e

Browse files
authored
Clarify directory needed to run generate-env.sh (#18)
Update QUICKSTART.md doc to clarify that one should change directories to the directory created by the pixi run task before attempting to run the generate-env.sh command.
1 parent 37822a1 commit cd3df1e

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/QUICKSTART.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,23 @@ docker compose version
4646
# If you haven't cloned yet
4747
git clone <your-repo-url>
4848
cd llm-in-a-box-template
49+
```
50+
51+
### 2. Run the initialization task
4952

53+
```bash
5054
pixi run tpl-init-cruft
5155
```
5256

53-
### 2. Set Up Environment Variables
57+
When prompted answer the questions asked by `pixi run`. The defaults
58+
work for a first exploration. Note the value entered for `project_slug`
59+
and change to the directory created with that name, e.g.
60+
61+
```bash
62+
cd llm_in_a_box
63+
```
64+
65+
### 3. Set Up Environment Variables
5466

5567
We've created an automated script to generate your `.env` file with secure values:
5668

@@ -66,7 +78,7 @@ This will create a `.env` file with:
6678
- API keys from your environment (if OPENAI_API_KEY or ANTHROPIC_API_KEY are set)
6779
- Standard database naming conventions (litellm, openwebui)
6880

69-
### 3. Add Your API Keys
81+
### 4. Add Your API Keys
7082

7183
You'll need to manually add API keys for the AI models you want to use:
7284

0 commit comments

Comments
 (0)