Deprecate id parameter when spawning Sandbox and add template p…

…arameter instead (#233)

.changeset/moody-zebras-doubt.md

@@ -0,0 +1,5 @@
+---
+"@e2b/cli": patch
+---
+
+Update template naming field when using CLI

.changeset/nasty-poets-press.md

@@ -0,0 +1,6 @@
+---
+"@e2b/python-sdk": patch
+"@e2b/sdk": patch
+---
+
+Deprecate id Sandbox parameter and add template parameter

apps/docs/src/app/cli/commands/page.mdx

@@ -17,15 +17,15 @@ 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>
 
 #### **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>
@@ -71,7 +71,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.
@@ -81,13 +81,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>
@@ -150,13 +150,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>

apps/docs/src/app/guide/custom-sandbox/page.mdx

@@ -129,9 +129,9 @@ 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_id = "1wdqsf9le9gk21ztb4mo"
 dockerfile = "e2b.Dockerfile"
-name = "my-agent-sandbox"
+template_name = "my-agent-sandbox"
 ```
 </CodeGroup>
 
@@ -153,15 +153,15 @@ 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}>
 ```js {{ language: 'js' }}
 import { Sandbox } from '@e2b/sdk'
 
 // Spawn your custom sandbox
-const sandbox = await Sandbox.create({ id: 'my-agent-sandbox' }) // $HighlightLine
+const sandbox = await Sandbox.create({ template: 'my-agent-sandbox' }) // $HighlightLine
 
 // Interact with sandbox. Learn more here:
 // https://e2b.dev/docs/sandbox/overview
@@ -174,7 +174,7 @@ await sandbox.close()
 from e2b import Sandbox
 
 # Spawn your custom sandbox
-sandbox = Sandbox(id="my-agent-sandbox") # $HighlightLine
+sandbox = Sandbox(template="my-agent-sandbox") # $HighlightLine
 
 # Interact with sandbox. Learn more here:
 # https://e2b.dev/docs/sandbox/overview

apps/docs/src/app/sandbox/custom/page.mdx

@@ -20,7 +20,7 @@ Once you build your custom sandbox template, you can spawn multiple isolated san
 
       // Create new sandbox
       const sandbox = await Sandbox.create({
-        id: '<sandbox-template-id>', // You get sandbox ID from the CLI after you run `$ e2b build`
+        template: '<sandbox-template-id>', // You get sandbox template ID from the CLI after you run `$ e2b build`
       })
 
       // Close sandbox once done
@@ -32,7 +32,7 @@ Once you build your custom sandbox template, you can spawn multiple isolated san
 
       # Create new sandbox
       sandbox = Sandbox(
-        id="<sandbox-template-id>", # You get sandbox ID from the CLI after you run `$ e2b build`
+        template="<sandbox-template>", # You get sandbox template from the CLI after you run `$ e2b build`
       )
 
       # Close sandbox once done

apps/docs/src/app/sandbox/templates/overview/page.mdx

@@ -32,8 +32,8 @@ Follow our [guide](/guide/custom-sandbox) on how to create a custom sandbox.
 
       // Create new sandbox
       const sandbox = await Sandbox.create({
-        // You get sandbox ID from the CLI after you run `$ e2b build`
-        id: '<sandbox-template-id>',  // $HighlightLine
+        // You get sandbox template from the CLI after you run `$ e2b build`
+        template: '<sandbox-template>',  // $HighlightLine
       })
 
       // Close sandbox once done
@@ -45,8 +45,8 @@ Follow our [guide](/guide/custom-sandbox) on how to create a custom sandbox.
 
       # Create new sandbox
       sandbox = Sandbox(
-        # You get sandbox ID from the CLI after you run `$ e2b build`
-        id="<sandbox-template-id>", # $HighlightLine
+        # You get sandbox template from the CLI after you run `$ e2b build`
+        template="<sandbox-template>", # $HighlightLine
       )
 
       # Close sandbox once done

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](/sandbox/api/envs) av
 </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 */}
-

apps/docs/src/app/sandbox/templates/start-cmd/page.mdx

@@ -84,9 +84,9 @@ The start command is specified inside the `e2b.toml` in the same directory where
 <CodeGroup isFileName title="e2b.toml" isRunnable={false}>
 ```toml
 # This is a config for E2B sandbox template
-id = "1wdqsf9le9gk21ztb4mo"
+template_id = "1wdqsf9le9gk21ztb4mo"
 dockerfile = "e2b.Dockerfile"
-name = "my-agent-sandbox"
+template_name = "my-agent-sandbox"
 start_cmd = "<your-start-command>"  # $HighlightLine
 ```
 </CodeGroup>

apps/docs/src/code/js/agents/clone_repo.js

@@ -3,7 +3,7 @@ import { Sandbox } from '@e2b/sdk'
 // 1. Start the playground sandbox
 const sandbox = await Sandbox.create({
   // You can pass your own sandbox template id
-  id: 'base',
+  template: 'base',
   apiKey: process.env.E2B_API_KEY,
 })
 

apps/docs/src/code/js/agents/code_exec.js

@@ -3,7 +3,7 @@ import { Sandbox } from '@e2b/sdk'
 // 1. Start the playground sandbox
 const sandbox = await Sandbox.create({
   // You can pass your own sandbox template id
-  id: 'base',
+  template: 'base',
 })
 
 // 2. Save the JavaScript code to a file inside the playground

apps/docs/src/code/js/agents/install_deps_npm.js

@@ -2,7 +2,7 @@ import { Sandbox } from '@e2b/sdk'
 
 // 1. Start the playground sandbox
 const sandbox = await Sandbox.create({
-  id: 'base', // $HighlightLine
+  template: 'base', // $HighlightLine
   apiKey: process.env.E2B_API_KEY,
 })
 

apps/docs/src/code/js/agents/start_process.js

@@ -3,7 +3,7 @@ import { Sandbox } from '@e2b/sdk'
 // 1. Start the playground sandbox
 const sandbox = await Sandbox.create({
   // You can pass your own sandbox template id
-  id: 'base',
+  template: 'base',
   apiKey: process.env.E2B_API_KEY,
 })
 

apps/docs/src/code/js/basics/download_file.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 import fs from 'node:fs'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 const buffer = await sandbox.downloadFile('path/to/remote/file/inside/sandbox') // $HighlightLine
 // Save file to local filesystem

apps/docs/src/code/js/basics/fs_ls.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
 })
 
 const dirContent = await sandbox.filesystem.list('/') // $HighlightLine

apps/docs/src/code/js/basics/fs_mkdir.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({ id: 'base' })
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // Create a new directory '/dir'
 await sandbox.filesystem.makeDir('/dir') // $HighlightLine

apps/docs/src/code/js/basics/fs_read.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 const fileContent = await sandbox.filesystem.read('/etc/hosts') // $HighlightLine
 console.log(fileContent)

apps/docs/src/code/js/basics/fs_read_bytes.js

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // File bytes will read file's content as bytes
 // `fileBytes` as a Uint8Array

apps/docs/src/code/js/basics/fs_watch.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // Start filesystem watcher for the /home directory
 const watcher = sandbox.filesystem.watchDir('/home') // $HighlightLine

apps/docs/src/code/js/basics/fs_write.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // `filesystem.write()` will:
 // - create the file if it doesn't exist

apps/docs/src/code/js/basics/fs_write_bytes.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // Let's convert string to bytes for testing purposes
 const encoder = new TextEncoder('utf-8')

apps/docs/src/code/js/basics/get_url.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 const url = sandbox.getHostname() // $HighlightLine
 console.log('https://' + url)

apps/docs/src/code/js/basics/get_url_port.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 const openPort = 3000
 const url = sandbox.getHostname(openPort) // $HighlightLine

apps/docs/src/code/js/basics/process_env_vars.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
   envVars: {FOO: 'Hello'},
 })
 

apps/docs/src/code/js/basics/process_exit.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
   onExit: () => console.log('[sandbox]', 'process ended'), // $HighlightLine
 })
 

apps/docs/src/code/js/basics/process_start.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 const npmInit = await sandbox.process.start({
   cmd: 'npm init -y', // $HighlightLine

apps/docs/src/code/js/basics/process_stop.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
 })
 
 const npmInit = await sandbox.process.start({

apps/docs/src/code/js/basics/process_stream_stderr.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
 })
 
 // This command will fail and output to stderr because Golang isn't installed in the cloud playground

apps/docs/src/code/js/basics/process_stream_stdout.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
   onStdout: (output) => console.log('sandbox', output.line), // $HighlightLine
 })
 

apps/docs/src/code/js/basics/process_write_stdin.js

@@ -1,6 +1,6 @@
 import { Sandbox } from '@e2b/sdk'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // This example will print back the string we send to the process using `sendStdin()`
 

apps/docs/src/code/js/basics/scan_ports.js

@@ -21,7 +21,7 @@ function printNewPortAndURL(openPorts, sandbox) {
 }
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
   onScanPorts: (openPorts) => printNewPortAndURL(openPorts, sandbox), // $HighlightLine
 })
 

apps/docs/src/code/js/basics/set_env_vars.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 
 const sandbox = await Sandbox.create({
-  id: 'base',
+  template: 'base',
   envVars: {FOO: 'Hello'}, // $HighlightLine
 })
 

apps/docs/src/code/js/basics/upload_file.js

@@ -1,7 +1,7 @@
 import { Sandbox } from '@e2b/sdk'
 import fs from 'node:fs'
 
-const sandbox = await Sandbox.create({id: 'base'})
+const sandbox = await Sandbox.create({ template: 'base' })
 
 // If you're in the server environment
 const filename = 'data.csv' // $HighlightLine