https://github.com/stainless-api/vscode-stainless
https://github.com/stainless-api/vscode-stainless
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stainless-api/vscode-stainless
- Owner: stainless-api
- License: mit
- Created: 2025-11-19T14:01:37.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-19T14:26:04.000Z (7 months ago)
- Last Synced: 2025-12-12T01:45:09.996Z (6 months ago)
- Size: 438 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stainless VSCode Extension
The official Visual Studio Code extension for working with [Stainless](https://stainlessapi.com) SDK configurations. This extension provides intelligent code editing support, real-time diagnostics, and powerful navigation features for Stainless config files and OpenAPI specifications.
## Workspace Setup
This extension works with Stainless workspaces. To set up a workspace, install the [Stainless CLI](https://github.com/stainless-api/stainless-api-cli) and run:
```bash
stl init
```
This creates a `.stainless/workspace.json` file, which the extension uses to identify your Stainless workspace and provide language support for your configuration files.
**Install the CLI with Homebrew** (recommended for macOS):
```bash
brew tap stainless-api/tap
brew install stl
```
**Or with Go**:
```bash
go install 'github.com/stainless-api/stainless-api-cli/cmd/stl@latest'
```
## Features
### **Real-time SDK diagnostics**
Get instant feedback on your SDK configuration as you type. The language server analyzes your Stainless config and OpenAPI spec in real-time, surfacing errors, warnings, and suggestions directly in your editor so you can catch issues before running a build.
### **“Go to definition” and “Find all references”**
Navigate your API specification with ease using “Go to defintion” to jump directly to schema definitions, parameters, and response types from your Stainless config. Use “Find all references” to see everywhere a schema or endpoint is used across your config and spec files.
### **Intelligent completions in your Stainless config**
Speed up editing your Stainless config with context-aware autocompletion. The language server suggests valid config options, endpoints, and schema names based on your OpenAPI spec.
### **Quick fixes and code actions**
Resolve diagnostics with a single click using code actions. Some common diagnostics will have an “Autofix”, and all warning diagnostics can be easily ignored.
### **Codelenses for your OpenAPI spec**
Codelenses show inline in your OpenAPI spec which schemas and endpoints are configured in your Stainless config. This makes it easy to see at a glance how your API is represented in your SDKs.
### **Live transformations**
See the results of your Stainless transformations instantly as you edit your config. The language server automatically generates and updates your transformed OpenAPI spec in real-time.
## Installation
Install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=stainless.vscode-stainless), or search for "Stainless" in the Extensions view (`Ctrl+Shift+X` / `Cmd+Shift+X`).
Once installed, open a workspace containing Stainless configuration files. You can verify the extension is active by checking the status indicator in the bottom right corner of your editor.
## Feedback and Support
For questions, feedback, or issues, please reach out to [local-dev@stainless.com](mailto:local-dev@stainless.com) or contact your Stainless sales representative.
## License
This VS Code extension is licensed under the MIT License. The Stainless Language Server is proprietary software, copyright © Stainless API, Inc.