Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Change mentions of `id` in the docs

Tomas Valentaffb3d63f0717
diff --git a/apps/docs/src/app/cli/commands/page.mdx b/apps/docs/src/app/cli/commands/page.mdx
index d327ca11f..c388971f8 100644
--- a/apps/docs/src/app/cli/commands/page.mdx
+++ b/apps/docs/src/app/cli/commands/page.mdx
@@ -17,7 +17,7 @@ e2b build
```
<Note>
-Running `e2b build` without specifying a template with the `[id]` argument will rebuild template defined by the `e2b.toml` config.
+Running `e2b build` without specifying a template with the `[template]` argument will rebuild template defined by the `e2b.toml` config.
If there is no `e2b.toml` config a new template will be created.
</Note>
@@ -25,7 +25,7 @@ If there is no `e2b.toml` config a new template will be created.
#### **Arguments**
<Options>
- <Option type="[id]">
+ <Option type="[template]">
Specify the template you want to rebuild. You can use the template name or ID.
</Option>
</Options>
@@ -68,7 +68,7 @@ e2b template init
## `delete`
-Delete the sandbox template specified by the `[id]` argument, `e2b.toml` config in the working directory, or by an interactive selection.
+Delete the sandbox template specified by the `[template]` argument, `e2b.toml` config in the working directory, or by an interactive selection.
By default, the root directory is the current working directory.
This command also deletes the `e2b.toml` config.
@@ -78,13 +78,13 @@ e2b delete
```
<Note>
-Running `e2b delete` without specifying a template with the `[id]` argument will delete the template defined by the `e2b.toml` config.
+Running `e2b delete` without specifying a template with the `[template]` argument will delete the template defined by the `e2b.toml` config.
</Note>
#### **Arguments**
<Options>
- <Option type="[id]">
+ <Option type="[template]">
Specify the template you want to delete. You can use the template name or ID.
</Option>
</Options>
@@ -147,13 +147,13 @@ e2b shell
```
<Note>
-Running `e2b shell` without specifying a template with the `[id]` argument will spawn sandbox defined by the `e2b.toml` config.
+Running `e2b shell` without specifying a template with the `[template]` argument will spawn sandbox defined by the `e2b.toml` config.
</Note>
#### **Arguments**
<Options>
- <Option type="[id]" name="template-name-or-id">
+ <Option type="[template]">
Specify the template you want to spawn sandbox from. You can use the template name or ID.
</Option>
</Options>
diff --git a/apps/docs/src/app/guide/custom-sandbox/page.mdx b/apps/docs/src/app/guide/custom-sandbox/page.mdx
index 10f7958fd..3234c33af 100644
--- a/apps/docs/src/app/guide/custom-sandbox/page.mdx
+++ b/apps/docs/src/app/guide/custom-sandbox/page.mdx
@@ -129,7 +129,7 @@ This will create the `e2b.toml` file storing the sandbox config.
<CodeGroup isFileName title="e2b.toml" isRunnable={false}>
```toml
# This is a config for E2B sandbox template
-id = "1wdqsf9le9gk21ztb4mo"
+template = "1wdqsf9le9gk21ztb4mo"
dockerfile = "e2b.Dockerfile"
name = "my-agent-sandbox"
```
@@ -153,7 +153,7 @@ e2b build
Now you can use the [E2B SDK](/getting-started/installation) to spawn & control your new custom sandbox.
-The sandbox template name is `my-agent-sandbox`. We'll use it as an unique identifier and pass it to the SDK as the `id` parameter.
+The sandbox template name is `my-agent-sandbox`. We'll use it as an unique identifier and pass it to the SDK as the `template` parameter.
This way, we'll be able to spawn our custom sandbox and control it with the SDK.
<CodeGroup title="Spawn & control your custom sandbox" isRunnable={true}>
diff --git a/apps/docs/src/app/sandbox/templates/premade/page.mdx b/apps/docs/src/app/sandbox/templates/premade/page.mdx
index d907a2017..f12f8a23e 100644
--- a/apps/docs/src/app/sandbox/templates/premade/page.mdx
+++ b/apps/docs/src/app/sandbox/templates/premade/page.mdx
@@ -21,7 +21,7 @@ To get your started quickly, we offer two premade sandboxes.
Template File
</Link>
<div className="pr-1 w-[320px] flex items-center justify-start space-x-2 border border-gray-600 rounded">
- <span className="font-mono text-sm w-8 h-8 flex items-center justify-center border-r border-gray-600">id</span>
+ <span className="font-mono text-sm w-8 h-8 flex items-center justify-center border-r border-gray-600">template</span>
<span className="font-mono text-sm text-gray-200">base</span>
</div>
@@ -49,7 +49,7 @@ The base sandbox has all the features of the [Sandbox API](/api/envs) available.
</Link>
<div className="pr-1 w-[320px] flex items-center justify-start space-x-2 border border-gray-600 rounded">
- <span className="font-mono text-sm w-8 h-8 flex items-center justify-center border-r border-gray-600">id</span>
+ <span className="font-mono text-sm w-8 h-8 flex items-center justify-center border-r border-gray-600">template</span>
<span className="font-mono text-sm text-gray-200">Python3-CodeInterpreter</span>
</div>
@@ -201,4 +201,3 @@ sandbox.close()
- Stream code errors
- Upload file
- Download file */}
-