-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
14 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters