diff --git a/typescript/vscode-ext/packages/README.md b/typescript/vscode-ext/packages/README.md index 0a7cbf5d3..d5f5e52ce 100644 --- a/typescript/vscode-ext/packages/README.md +++ b/typescript/vscode-ext/packages/README.md @@ -1,35 +1,29 @@ # Baml Language VS Code Extension -This VS Code extension provides support for the Baml language used to define function-based LLM pipelines. +This VS Code extension provides support for the Baml language used to define LLM functions, test them in the integrated LLM Playground and build agentic workflows. ### General features -1. **Auto-build on Save**: Anytime a `.baml` file is saved, the build script is automatically triggered. -2. **Syntax Highlighting**: Provides enhanced readability and coding experience by highlighting the Baml language syntax for any file with the `.baml` extension. +1. **Syntax Highlighting**: Provides enhanced readability and coding experience by highlighting the Baml language syntax for any file with the `.baml` extension. +2. **Dynamic playground**: Run and test your prompts in real-time. +3. **Build typed clients in several languages**: Command +S a baml file to build a baml client to call your functions in Python or TS. -## Prerequisites -### MacOS - -First, install the **baml CLI**: - -1. `brew tap boundaryml/baml` -2. `brew install baml` +## Usage -To update the CLI +1. **Install BAML dependency**: -1. `brew update` -2. `brew upgrade baml` +* python: `pip install baml-py` +* typescript: `npm install @boundaryml/baml` -See [the documentation](https://docs.boundaryml.com/mdx/installation) for full instructions for all platforms +2. **Create a baml_src directory with a main.baml file and you're all set!** -## Usage +3. **Add your own api keys in the playground to test your functions** -Create a baml_src directory with a main.baml file and you're all set! -**Auto-build on Save**: -When you save your `.baml` files (`Ctrl+S`), the build script (`baml build`) will automatically run. +4. See more examples at **[promptfiddle.com](promptfiddle.com) ---- +## Documentation +See our [documentation](https://docs.boundaryml.com) For any issues, feature requests, or contributions, please reach out at contact@boundaryml.com diff --git a/typescript/vscode-ext/packages/package.json b/typescript/vscode-ext/packages/package.json index 5ba24f1c8..c608bffb2 100644 --- a/typescript/vscode-ext/packages/package.json +++ b/typescript/vscode-ext/packages/package.json @@ -2,7 +2,7 @@ "name": "baml-extension", "displayName": "Baml", "description": "BAML is a DSL for AI applications.", - "version": "0.33.0", + "version": "0.33.1", "publisher": "Boundary", "repository": "https://github.com/BoundaryML/baml", "homepage": "https://www.boundaryml.com", diff --git a/typescript/vscode-ext/packages/snippets/basicSnippets.json b/typescript/vscode-ext/packages/snippets/basicSnippets.json index fb1df4a87..2afcf2139 100644 --- a/typescript/vscode-ext/packages/snippets/basicSnippets.json +++ b/typescript/vscode-ext/packages/snippets/basicSnippets.json @@ -37,7 +37,6 @@ ], "description": "Custom BAML function snippet" }, - "@skip": { "prefix": "@skip", "body": ["@skip"],