Skip to content

Commit 075d978

Browse files
kemingyCopilot
andauthored
fix: explain where the env name comes from (#320)
* fix: explain where the env name comes from Signed-off-by: Keming <kemingyang@tensorchord.ai> * Update docs-zh/guide/build-envd.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Keming <kemingy94@gmail.com> --------- Signed-off-by: Keming <kemingyang@tensorchord.ai> Signed-off-by: Keming <kemingy94@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent f885318 commit 075d978

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

docs-zh/guide/build-envd.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,14 @@ $ envd up
8585

8686
</custom-title>
8787

88-
3. 重新进入您的环境,如果您退出了当前 `shell`,使用 `ssh <project-directory-name>.envd` 命令将重新进入环境。
88+
3. 重新进入您的环境,如果您退出了当前 `shell`,使用 `ssh <project-directory-name>.envd` 命令将重新进入环境。环境名称也可以通过 `envd up --name <custom-name>` 自定义。
8989

9090
```bash
9191
⬢ [envd]❯ exit
92-
$ ssh demo.envd
92+
# 列出当前可用的 envd 环境
93+
$ envd envs ls
94+
# 重新连接到该环境
95+
$ ssh <project-directory-name>.envd
9396
⬢ [envd]❯ # 欢迎回来!
9497
```
9598

docs/guide/build-envd.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Usage
66

7-
The `envd build` command builds an image from a `build.envd`. `envd up` command builds an image and runs immediately. Traditionally, the `build.envd` and located in the root of the context. You use the `--path` or `-p` flag with `envd build`/`envd up` to point to a directory anywhere in your file system which contains a `build.envd`.
7+
The `envd build` command builds an image from a `build.envd`. `envd up` command builds an image and runs immediately. Traditionally, the `build.envd` and located in the root of the context. You use the `--path` or `-p` flag with `envd build`/`envd up` to point to a directory anywhere in your file system which contains a `build.envd`.
88

99
```bash
1010
$ ls
@@ -83,13 +83,16 @@ $ envd up
8383

8484
</custom-title>
8585

86-
You can use `ssh <project-directory-name>.envd` to attach to the environment if you exit from the shell.
86+
You can use `ssh <project-directory-name>.envd` to attach to the environment if you exit from the shell. This name can also be customized via `envd up --name <custom-name>`.
8787

8888
<custom-title title="connect the environment via ssh">
8989

9090
```bash
9191
⬢ [envd]❯ exit
92-
$ ssh demo.envd
92+
# to list the current available envd environments
93+
$ envd envs ls
94+
# to re-connect to the environment
95+
$ ssh <project-directory-name>.envd
9396
⬢ [envd]❯ # You are in the environment again!
9497
```
9598

0 commit comments

Comments
 (0)