{"id":19747996,"url":"https://github.com/tensorchord/vscode-envd","last_synced_at":"2025-04-30T08:33:07.027Z","repository":{"id":37371567,"uuid":"502620323","full_name":"tensorchord/vscode-envd","owner":"tensorchord","description":"vscode extension for envd","archived":false,"fork":false,"pushed_at":"2023-05-22T04:35:14.000Z","size":6992,"stargazers_count":2,"open_issues_count":5,"forks_count":4,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-02-25T12:34:39.691Z","etag":null,"topics":["envd","mlops","visual-studio-code","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=tensorchord.vscode-envd","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tensorchord.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-06-12T13:14:41.000Z","updated_at":"2023-05-22T04:19:57.000Z","dependencies_parsed_at":"2024-01-23T22:05:36.629Z","dependency_job_id":null,"html_url":"https://github.com/tensorchord/vscode-envd","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fvscode-envd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fvscode-envd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fvscode-envd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fvscode-envd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tensorchord","download_url":"https://codeload.github.com/tensorchord/vscode-envd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224203383,"owners_count":17272939,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["envd","mlops","visual-studio-code","vscode","vscode-extension"],"created_at":"2024-11-12T02:19:42.406Z","updated_at":"2024-11-12T02:19:44.085Z","avatar_url":"https://github.com/tensorchord.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"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)\n\nThe `envd extension` helps to build, manage or destroy environments of `envd`. It provides user friendly interface for most common environments, images and contexts operations.\n\n![image](./docs/images/extension.gif)\n\n## Installation\n\nBy default, `envd extension` use system `pip3` to manage `envd` executable.\n\nYou don't need to install `envd` manually. We would arrange all for you.\n\nTo use another `pip` manager rather than the system default, you could choose it in the options.\n\n![image](./docs/images/pick-manager.gif)\n\nIf 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.\n\n![image](./docs/images/pick-path.gif)\n\n## Overview of the extension features\n\n### Editing envd files\n\nYou can get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense) when editing your `build.envd` files, with completions and syntax help for common functions.\n\n![image](./docs/images/code-edit.gif)\n\n### Build envd environment\n\nWe 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). \n\nThough 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.\n\n| **✔️** Good entries | ⚠️ Bad entries   | ❌ Unrecognized |\n| ------------------ | --------------- | -------------- |\n| `build()`          | `build010()`    | `BUILD()`      |\n| `jupyter_build()`  | `nvidiabuild()` | `Build()`      |\n| `build_GPU()`      | `buildings()`   | `jupyter()`    |\n\n![image](./docs/images/env-build.gif)\n\n### Environment Explorer\n\nThe `envd extension` contributes an `envd` Explorer view to VS Code. The Explorer lets you examine and manage `envd` assets: environments, images and contexts. \n\n![image](./docs/images/explorer.gif)\n\nTo remove any environment, image or context, you could choose `Remove` or `Destroy` from right-click menu.\n\n![image](./docs/images/explorer-destroy.gif)\n\n### Attach to environment\n\nThis 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.\n\nTo 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.\n\nTo 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.\n\n![image](./docs/images/attach.gif)\n\nSome environments will provide endpoint like `jupyter`, you could attach to them by click either.\n\n![image](./docs/images/attach-endpoint.gif)\n\n### New version notification and installation\n\nWhen 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.\n\n![image](./docs/images/auto-update.gif)\n\nYou can also switch the version of `envd` at any time you want if the `pip` package manager is enabled.\n\n![image](./docs/images/switch-version.gif)\n\n## Acknowledgement\n\n- Thank [vsode-tilt](https://github.com/tilt-dev/vscode-tilt) for its vscode extension.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorchord%2Fvscode-envd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftensorchord%2Fvscode-envd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorchord%2Fvscode-envd/lists"}