From 1a21f56649279dae256ef8984a5ba6f59e81a97b Mon Sep 17 00:00:00 2001 From: colinmcneil Date: Fri, 17 Jan 2025 17:41:19 -0500 Subject: [PATCH] Add VSCode quickstart docs --- docs/content/tools/quickstart.md | 43 +++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/content/tools/quickstart.md b/docs/content/tools/quickstart.md index 45e0601..5aa4cfd 100644 --- a/docs/content/tools/quickstart.md +++ b/docs/content/tools/quickstart.md @@ -1,12 +1,49 @@ --- -title: Quick Start +title: Quick Start w/ VSCode weight: 1 --- {{% steps %}} -### Step 1 +### Download `.vsix` extension -### second +Download the `.vsix` extension from the [releases page](https://github.com/docker/labs-ai-tools-vscode/releases). + +### Install extension from `.vsix` file + +```sh +code --install-extension +``` + +or use the VSCode command palette `Extensions: Install from VSIX...` + +### Open a prompt +With the extension installed, open a prompt in VSCode. Examples can be found in the [examples](https://github.com/docker/labs-ai-tools-for-devs/tree/main/prompts/examples) directory. + +### Configure OpenAI API Key, or use a different model. +Default model is `gpt-4` provided by OpenAI. Use an the VSCode command palette `Docker AI: Set secret key` to set your API key. + +**Changing the model:** +Use the following keys in the prompt front-matter to change the model: + +Anthropic: +```yml +--- +url: https://api.anthropic.com +model: claude-3-5-sonnet-20240620 +--- +``` + + +Ollama: +```yml +--- +model: llama3.2 +url: https://docker.host.internal:11434/v1 +--- +``` + +### Run the prompt +Use the VSCode command palette `Docker AI: Run this prompt` to run the prompt. {{% /steps %}}