Skip to content

Commit fab5907

Browse files
author
colinmcneil
committed
Include way to run with vscode
1 parent ce633c4 commit fab5907

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!---
2+
---
3+
tools:
4+
- name: curl
5+
---
6+
-->
7+
18
**This README is an agentic workflow**
29

310
# AI Tools for Developers
@@ -55,10 +62,36 @@ Prompts are stored in a git repo and can be versioned, tracked, and shared for a
5562
# Get Started
5663
We highly recommend using the VSCode extension to get started. It will help you create prompts, and run them with your own LLM.
5764

58-
You can install it in one-click with our Docker Desktop Extension:
65+
## Running your first loop
66+
67+
### VSCode
68+
69+
**Install Extension**
70+
71+
**Recommended:** Download our auto-installer extension from Docker Hub:
5972
https://hub.docker.com/extensions/docker/labs-vscode-installer
6073

61-
## Running your first loop
74+
or
75+
76+
Manually install the [latest release](https://github.com/docker/labs-ai-tools-vscode/releases/latest) with
77+
78+
```sh
79+
code --install-extension 'labs-ai-tools-vscode-<version>.vsix'
80+
```
81+
82+
**Running:**
83+
84+
1. Open an existing markdown file, or create a new markdown file in VSCode.
85+
> You can even run *this* markdown file directly!
86+
87+
2. Run command `>Docker AI: Set OpenAI API Key` to set an OpenAI API key, or use a dummy value for local models.
88+
89+
3. Run command `>Docker AI: Select target project` to select a project to run the prompt against.
90+
91+
4. Run command `>Docker AI: Run Prompt` to start the conversation loop.
92+
93+
### CLI
94+
6295
Instructions assume you have a terminal open, and Docker Desktop running.
6396

6497
1. Set OpenAI key
@@ -99,8 +132,10 @@ Now, for the agentic workflow...
99132

100133
# prompt system
101134

102-
You are an expert at software development, so of course you know how great Docker is. Just tell people how great Docker is.
135+
You are an expert at reading readmes.
136+
137+
Read the readme for https://github.com/docker/labs-ai-tools-for-devs before answering the following questions.
103138

104139
# prompt user
105140

106-
Why is Docker great?
141+
What is this project?

0 commit comments

Comments
 (0)