{"id":19747982,"url":"https://github.com/tensorchord/envd-quick-start","last_synced_at":"2025-10-14T02:02:35.373Z","repository":{"id":42177194,"uuid":"501212456","full_name":"tensorchord/envd-quick-start","owner":"tensorchord","description":"demo for envd","archived":false,"fork":false,"pushed_at":"2025-02-06T04:23:24.000Z","size":13,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-30T08:49:19.124Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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":null,"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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-06-08T10:59:31.000Z","updated_at":"2025-04-24T16:02:28.000Z","dependencies_parsed_at":"2025-04-30T08:48:53.807Z","dependency_job_id":null,"html_url":"https://github.com/tensorchord/envd-quick-start","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tensorchord/envd-quick-start","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fenvd-quick-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fenvd-quick-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fenvd-quick-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fenvd-quick-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tensorchord","download_url":"https://codeload.github.com/tensorchord/envd-quick-start/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tensorchord%2Fenvd-quick-start/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017542,"owners_count":26086113,"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","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-12T02:19:41.982Z","updated_at":"2025-10-14T02:02:35.340Z","avatar_url":"https://github.com/tensorchord.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tutorial\n\nenvd is a container-based development environment management tool for data scientists.\n\n🐍 **No docker, only python** - Write python code to build the development environment, we help you take care of Docker.\n\n🖨️ **Built-in jupyter/vscode** - Jupyter and VSCode remote extension are the first-class support.\n\n⏱️ **Save time** - Better cache management to save your time, keep the focus on the model, instead of dependencies\n\n☁️ **Local \u0026 cloud** - Run the environment locally or in the cloud, without any code change\n\n🐳 **Container native** - Leverage container technologies but no need to learn how to use them, we optimize it for you\n\n🤟 **Infrastructure as code** - Describe your project in a declarative way, 100% reproducible\n\nLet's discover **envd in less than 5 minutes**.\n\n## Getting Started\n\nGet started by **creating a new envd environment**.\n\n### What you'll need\n\n- Docker (20.10.0 or above)\n\n### Install envd\n\nYou can download the binary from the [latest release page](https://github.com/tensorchord/envd/releases/latest), and add it in `$PATH`.\n\nAfter the download, please run `envd bootstrap` to bootstrap.\n\n### Create an envd environment\n\nPlease clone the [`envd-quick-start`](https://github.com/tensorchord/envd-quick-start):\n\n```\ngit clone https://github.com/tensorchord/envd-quick-start.git\n```\n\nThe build manifest `build.envd` looks like:\n\n```python\ndef build():\n    base(dev=True)\n    install.conda()\n    install.python()\n    install.python_packages(name = [\n        \"numpy\",\n    ])\n    shell(\"fish\")\n```\n\nThen please run the command below to setup a new environment:\n\n```\ncd envd-quick-start \u0026\u0026 envd up\n```\n\n```bash\n$ cd envd-quick-start \u0026\u0026 envd up\n[+] ⌚ parse build.envd and download/cache dependencies 6.2s ✅ (finished) \n[+] build envd environment 19.0s (47/47) FINISHED                                                 \n =\u003e CACHED [internal] setting pip cache mount permissions                                     0.0s\n =\u003e docker-image://docker.io/tensorchord/envd-sshd-from-scratch:v0.4.3                        2.3s\n =\u003e =\u003e resolve docker.io/tensorchord/envd-sshd-from-scratch:v0.4.3                            2.3s\n =\u003e docker-image://docker.io/library/ubuntu:22.04                                             0.0s\n......\n =\u003e [internal] pip install numpy                                                              2.5s\n =\u003e CACHED [internal] download fish shell                                                     0.0s\n =\u003e [internal] configure user permissions for /opt/conda                                      1.0s\n =\u003e [internal] create dir for ssh key                                                         0.5s\n =\u003e [internal] install ssh keys                                                               0.2s\n =\u003e [internal] copy fish shell from the builder image                                         0.2s\n =\u003e [internal] install fish shell                                                             0.5s\n......\n =\u003e [internal] create work dir: /home/envd/envd-quick-start                                   0.2s\n =\u003e exporting to image                                                                        7.7s\n =\u003e =\u003e exporting layers                                                                       7.7s\n =\u003e =\u003e writing image sha256:464a0c12759d3d1732404f217d5c6e06d0ee4890cccd66391a608daf2bd314e4  0.0s\n =\u003e =\u003e naming to docker.io/library/envd-quick-start:dev                                       0.0s\n------\n \u003e importing cache manifest from docker.io/tensorchord/python-cache:envd-v0.4.3:\n------\n⣽ [5/5] attach the environment  [2s]            \nWelcome to fish, the friendly interactive shell\nType help for instructions on how to use fish\n\nenvd-quick-start on git master [!] via Py v3.11.11 via 🅒 envd as sudo \n⬢ [envd]❯ # You are in the container-based environment!\n```\n\n### Play with the environment\n\nYou can run `ssh envd-quick-start.envd` to reconnect if you exit from the environment. Or you can execute `git` or `python` commands inside.\n\n```bash\n$ python demo.py\n[2 3 4]\n$ git fetch\n$\n```\n\n### Setup jupyter notebook\n\nPlease edit the `build.envd` to enable jupyter notebook:\n\n```python\ndef build():\n    base(dev=True)\n    install.conda()\n    install.python()\n    install.python_packages(name = [\n        \"numpy\",\n    ])\n    shell(\"fish\")\n    config.jupyter(password=\"\", port=8888)\n```\n\nYou can get the endpoint of jupyter notebook via `envd get envs`.\n\n```bash\n$ envd up --detach\n$ envd get env\nNAME                    JUPYTER                 SSH TARGET              CONTEXT                                 IMAGE                   GPU     CUDA    CUDNN   STATUS          CONTAINER ID \nenvd-quick-start        http://localhost:8888   envd-quick-start.envd   /home/gaocegege/code/envd-quick-start   envd-quick-start:dev    false   \u003cnone\u003e  \u003cnone\u003e  Up 54 seconds   bd3f6a729e94\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorchord%2Fenvd-quick-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftensorchord%2Fenvd-quick-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftensorchord%2Fenvd-quick-start/lists"}