https://github.com/tensorchord/vscode-envd

vscode extension for envd
https://github.com/tensorchord/vscode-envd

envd mlops visual-studio-code vscode vscode-extension

Last synced: about 1 month ago
JSON representation

vscode extension for envd

• Host: GitHub
• URL: https://github.com/tensorchord/vscode-envd
• Owner: tensorchord
• License: apache-2.0
• Created: 2022-06-12T13:14:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-22T04:35:14.000Z (over 1 year ago)
• Last Synced: 2024-02-25T12:34:39.691Z (10 months ago)
• Topics: envd, mlops, visual-studio-code, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=tensorchord.vscode-envd
• Size: 6.67 MB
• Stars: 2
• Watchers: 10
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Envd for Visual Studio Code  [![Version](https://img.shields.io/visual-studio-marketplace/v/tensorchord.vscode-envd)](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) [![Installs](https://img.shields.io/visual-studio-marketplace/i/tensorchord.vscode-envd)](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) ![Build Status](https://github.com/tensorchord/vscode-envd/actions/workflows/CI.yml/badge.svg)

The `envd extension` helps to build, manage or destroy environments of `envd`. It provides user friendly interface for most common environments, images and contexts operations.

![image](./docs/images/extension.gif)

## Installation

By default, `envd extension` use system `pip3` to manage `envd` executable.

You don't need to install `envd` manually. We would arrange all for you.

To use another `pip` manager rather than the system default, you could choose it in the options.

![image](./docs/images/pick-manager.gif)

If you don't like any package manager, you can also point to an absolute `envd` executable path. In this case, the version check and update prompt will be disabled.

![image](./docs/images/pick-path.gif)

## Overview of the extension features

### Editing envd files

You can get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense) when editing your `build.envd` files, with completions and syntax help for common functions.

![image](./docs/images/code-edit.gif)

### Build envd environment

We support `envd up` and `envd build` commands for each `def build_xxx()` entry. These commands will be provided as [CodeLens](https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup). 

Though any function could be used as an entry, only functions containing `build` will be recognized as an entry. As `build()` is `envd` default entry, we hope everyone could have a good practice.

| **✔️** Good entries | ⚠️ Bad entries   | ❌ Unrecognized |

| ------------------ | --------------- | -------------- |

| `build()`          | `build010()`    | `BUILD()`      |

| `jupyter_build()`  | `nvidiabuild()` | `Build()`      |

| `build_GPU()`      | `buildings()`   | `jupyter()`    |

![image](./docs/images/env-build.gif)

### Environment Explorer

The `envd extension` contributes an `envd` Explorer view to VS Code. The Explorer lets you examine and manage `envd` assets: environments, images and contexts. 

![image](./docs/images/explorer.gif)

To remove any environment, image or context, you could choose `Remove` or `Destroy` from right-click menu.

![image](./docs/images/explorer-destroy.gif)

### Attach to environment

This is a special feature for the `VSCode` platform, the extension will provide similar usage to `VSCode Remote Development` extension. If you are familiar with development at `Remote-SSH` or `wsl`, things will be easy.

To attach to an `envd` environment at a `VSCode` Terminal, you could click `Attach to terminal` from `Environment Explorer` of every environment item, or right-click menu.

To attach to an `envd` environment at a new `VSCode` Window, you could click `Attach to VSCode` from `Environment Explorer` of every environment item, or right-click menu.

![image](./docs/images/attach.gif)

Some environments will provide endpoint like `jupyter`, you could attach to them by click either.

![image](./docs/images/attach-endpoint.gif)

### New version notification and installation

When a new version of `envd` is available, `envd extension` will show a notification, and instruct you to install it in need. This happens every time the extension is activated. If you need to fix `envd` version, turn off the `Check Version` checkbox at options.

![image](./docs/images/auto-update.gif)

You can also switch the version of `envd` at any time you want if the `pip` package manager is enabled.

![image](./docs/images/switch-version.gif)

## Acknowledgement

- Thank [vsode-tilt](https://github.com/tilt-dev/vscode-tilt) for its vscode extension.