Breck Chat is a VS Code extension that provides two main features:
- Quick access to Breck package documentation through natural language prompts
- A visual GUI for running Breck CLI commands
Requirements
- Authentication via a Striven asset to use the Chat feature.
- The
breckCLI on your PATH to use the command runner (installed with your Breck project's dependencies).
Features
Documentation Search
To find docs, simply write @breck /docs <your prompt>.
Breck CLI Command Runner
Run Breck CLI commands (generate, model, module, update) from a user-friendly GUI:
- Open a Breck workspace
- Open the Miles Development Tools view in the activity bar
- In the Commands tree, expand generate and pick a schematic, expand model and pick a subcommand, or click module/update
- Fill out the form with your options; a live command preview updates as you type
- Click "Run" (or "Dry Run" for generators) to execute the command in a task terminal
The command list and every form field come from breck --schema-json, so the UI always matches your installed CLI. Array-type fields accept comma-separated values.
Common Issues
- No commands showing:
- Make sure the
breckCLI is installed and on your PATH - Verify the packages are installed (
npm install) so schematic inputs can be discovered
- Make sure the
Release Notes
v0.0.2 is the initial release. This release includes a single command, @breck /docs <your prompt>.
v0.0.3 fixed an error when submitting an empty prompt.