Skip to content

armgit / E2B

Public Imported from GitHub
0

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

Add alias to list command

Jakub Novak363b577c6955
diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts
index 86c453a6e..52716ff98 100644
--- a/packages/cli/src/commands/index.ts
+++ b/packages/cli/src/commands/index.ts
@@ -8,7 +8,7 @@ import { listCommand } from './list'
import { shellCommand } from './shell'
import { initCommand } from './init'
import { deleteCommand } from './delete'
-import { instancesCommand } from './instances'
+import { runningSandboxesCommand } from './sandboxes'
export const program = new commander.Command()
.description(`Create sandbox templates from Dockerfiles by running ${asPrimary('e2b build')} then use our SDKs to create sandboxes from these templates.
@@ -22,4 +22,4 @@ Visit ${asPrimary('E2B docs (https://e2b.dev/docs)')} to learn how to create san
.addCommand(shellCommand)
.addCommand(initCommand)
.addCommand(deleteCommand)
- .addCommand(instancesCommand)
+ .addCommand(runningSandboxesCommand)
diff --git a/packages/cli/src/commands/instances.ts b/packages/cli/src/commands/sandboxes.ts
similarity index 88%
rename from packages/cli/src/commands/instances.ts
rename to packages/cli/src/commands/sandboxes.ts
index b32e24fa2..4c07e212c 100644
--- a/packages/cli/src/commands/instances.ts
+++ b/packages/cli/src/commands/sandboxes.ts
@@ -8,9 +8,9 @@ const listRunningSandboxes = e2b.withAPIKey(
e2b.api.path('/instances').method('get').create(),
)
-export const instancesCommand = new commander.Command('instances')
- .description('List all sandboxes')
- .alias('ins')
+export const runningSandboxesCommand = new commander.Command('sandboxes')
+ .description('List all running sandboxes')
+ .alias('sndbx')
.action(async () => {
try {
const apiKey = ensureAPIKey()
@@ -24,6 +24,7 @@ export const instancesCommand = new commander.Command('instances')
columns: [
{ name: 'instanceID', alignment: 'left', title: 'Sandbox ID' },
{ name: 'envID', alignment: 'left', title: 'Template ID' },
+ { name: 'alias', alignment: 'left', title: 'Alias' },
{ name: 'startedAt', alignment: 'left', title: 'Started at' },
{ name: 'metadata', alignment: 'left', title: 'Metadata'},
],
diff --git a/packages/js-sdk/src/api/schema.gen.ts b/packages/js-sdk/src/api/schema.gen.ts
index c1a7f6fd1..7a7cc2b70 100644
--- a/packages/js-sdk/src/api/schema.gen.ts
+++ b/packages/js-sdk/src/api/schema.gen.ts
@@ -264,6 +264,8 @@ export interface components {
envID: string;
/** @description Identifier of the instance */
instanceID: string;
+ /** @description Alias of the environment */
+ alias?: string;
/** @description Identifier of the client */
clientID: string;
};
@@ -279,6 +281,8 @@ export interface components {
RunningInstance: {
/** @description Identifier of the environment from which is the instance created */
envID: string;
+ /** @description Alias of the environment */
+ alias?: string;
/** @description Identifier of the instance */
instanceID: string;
/** @description Identifier of the client */
diff --git a/packages/js-sdk/src/sandbox/sandboxConnection.ts b/packages/js-sdk/src/sandbox/sandboxConnection.ts
index e864ce351..324fd0e31 100644
--- a/packages/js-sdk/src/sandbox/sandboxConnection.ts
+++ b/packages/js-sdk/src/sandbox/sandboxConnection.ts
@@ -37,9 +37,10 @@ export interface SandboxMetadata {
[key: string]: string;
}
-export interface RunningInstance {
+export interface RunningSandbox {
sandboxID: string;
templateID: string;
+ alias?: string;
metadata?: SandboxMetadata;
}
@@ -143,11 +144,11 @@ export class SandboxConnection {
* List all running sandboxes
* @param apiKey API key to use for authentication. If not provided, the `E2B_API_KEY` environment variable will be used.
*/
- static async list(apiKey?: string): Promise<RunningInstance[]> {
+ static async list(apiKey?: string): Promise<RunningSandbox[]> {
apiKey = getApiKey(apiKey)
try {
const res = await listSandboxes(apiKey, {})
- return res.data.map((instance) => ({ sandboxID: instance.instanceID, templateID: instance.envID, metadata: instance.metadata }))
+ return res.data.map((instance) => ({ sandboxID: instance.instanceID, alias: instance.alias, templateID: instance.envID, metadata: instance.metadata }))
} catch (e) {
if (e instanceof listSandboxes.Error) {
const error = e.getActualType()
diff --git a/packages/python-sdk/e2b/api/v1/client/models/instance.py b/packages/python-sdk/e2b/api/v1/client/models/instance.py
index 187481472..c91adb00a 100644
--- a/packages/python-sdk/e2b/api/v1/client/models/instance.py
+++ b/packages/python-sdk/e2b/api/v1/client/models/instance.py
@@ -18,6 +18,7 @@ import re # noqa: F401
import json
+from typing import Optional
from pydantic import BaseModel, Field, StrictStr
@@ -34,10 +35,11 @@ class Instance(BaseModel):
instance_id: StrictStr = Field(
..., alias="instanceID", description="Identifier of the instance"
)
+ alias: Optional[StrictStr] = Field(None, description="Alias of the environment")
client_id: StrictStr = Field(
..., alias="clientID", description="Identifier of the client"
)
- __properties = ["envID", "instanceID", "clientID"]
+ __properties = ["envID", "instanceID", "alias", "clientID"]
class Config:
"""Pydantic configuration"""
@@ -84,6 +86,7 @@ class Instance(BaseModel):
{
"env_id": obj.get("envID"),
"instance_id": obj.get("instanceID"),
+ "alias": obj.get("alias"),
"client_id": obj.get("clientID"),
}
)
diff --git a/packages/python-sdk/e2b/api/v1/client/models/running_instance.py b/packages/python-sdk/e2b/api/v1/client/models/running_instance.py
index f335a3a94..694bd8c8c 100644
--- a/packages/python-sdk/e2b/api/v1/client/models/running_instance.py
+++ b/packages/python-sdk/e2b/api/v1/client/models/running_instance.py
@@ -32,6 +32,7 @@ class RunningInstance(BaseModel):
alias="envID",
description="Identifier of the environment from which is the instance created",
)
+ alias: Optional[StrictStr] = Field(None, description="Alias of the environment")
instance_id: StrictStr = Field(
..., alias="instanceID", description="Identifier of the instance"
)
@@ -42,7 +43,7 @@ class RunningInstance(BaseModel):
..., alias="startedAt", description="Time when the instance was started"
)
metadata: Optional[Dict[str, StrictStr]] = None
- __properties = ["envID", "instanceID", "clientID", "startedAt", "metadata"]
+ __properties = ["envID", "alias", "instanceID", "clientID", "startedAt", "metadata"]
class Config:
"""Pydantic configuration"""
@@ -88,6 +89,7 @@ class RunningInstance(BaseModel):
_obj = RunningInstance.parse_obj(
{
"env_id": obj.get("envID"),
+ "alias": obj.get("alias"),
"instance_id": obj.get("instanceID"),
"client_id": obj.get("clientID"),
"started_at": obj.get("startedAt"),
diff --git a/packages/python-sdk/e2b/api/v2/client/models/instance.py b/packages/python-sdk/e2b/api/v2/client/models/instance.py
index c23a569ae..4803e408c 100644
--- a/packages/python-sdk/e2b/api/v2/client/models/instance.py
+++ b/packages/python-sdk/e2b/api/v2/client/models/instance.py
@@ -18,7 +18,7 @@ import re # noqa: F401
import json
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
from pydantic import BaseModel, StrictStr
from pydantic import Field
@@ -40,10 +40,13 @@ class Instance(BaseModel):
instance_id: StrictStr = Field(
description="Identifier of the instance", alias="instanceID"
)
+ alias: Optional[StrictStr] = Field(
+ default=None, description="Alias of the environment"
+ )
client_id: StrictStr = Field(
description="Identifier of the client", alias="clientID"
)
- __properties: ClassVar[List[str]] = ["envID", "instanceID", "clientID"]
+ __properties: ClassVar[List[str]] = ["envID", "instanceID", "alias", "clientID"]
model_config = {"populate_by_name": True, "validate_assignment": True}
@@ -99,6 +102,7 @@ class Instance(BaseModel):
{
"envID": obj.get("envID"),
"instanceID": obj.get("instanceID"),
+ "alias": obj.get("alias"),
"clientID": obj.get("clientID"),
}
)
diff --git a/packages/python-sdk/e2b/api/v2/client/models/running_instance.py b/packages/python-sdk/e2b/api/v2/client/models/running_instance.py
index 5322f8c27..086765330 100644
--- a/packages/python-sdk/e2b/api/v2/client/models/running_instance.py
+++ b/packages/python-sdk/e2b/api/v2/client/models/running_instance.py
@@ -37,6 +37,9 @@ class RunningInstance(BaseModel):
description="Identifier of the environment from which is the instance created",
alias="envID",
)
+ alias: Optional[StrictStr] = Field(
+ default=None, description="Alias of the environment"
+ )
instance_id: StrictStr = Field(
description="Identifier of the instance", alias="instanceID"
)
@@ -49,6 +52,7 @@ class RunningInstance(BaseModel):
metadata: Optional[Dict[str, StrictStr]] = None
__properties: ClassVar[List[str]] = [
"envID",
+ "alias",
"instanceID",
"clientID",
"startedAt",
@@ -108,6 +112,7 @@ class RunningInstance(BaseModel):
_obj = cls.model_validate(
{
"envID": obj.get("envID"),
+ "alias": obj.get("alias"),
"instanceID": obj.get("instanceID"),
"clientID": obj.get("clientID"),
"startedAt": obj.get("startedAt"),
diff --git a/packages/python-sdk/e2b/sandbox/sandbox_connection.py b/packages/python-sdk/e2b/sandbox/sandbox_connection.py
index bafd984e9..fd30edf12 100644
--- a/packages/python-sdk/e2b/sandbox/sandbox_connection.py
+++ b/packages/python-sdk/e2b/sandbox/sandbox_connection.py
@@ -48,9 +48,10 @@ class SubscriptionArgs(BaseModel):
params: List[Any] = []
-class RunningSandboxes(BaseModel):
+class RunningSandbox(BaseModel):
sandbox_id: str
template_id: str
+ alias: Optional[str]
metadata: Dict[str, str]
@@ -459,7 +460,7 @@ class SandboxConnection:
self._close()
@staticmethod
- def list(api_key: Optional[str] = None) -> List[RunningSandboxes]:
+ def list(api_key: Optional[str] = None) -> List[RunningSandbox]:
"""
List all running sandboxes.
@@ -470,9 +471,10 @@ class SandboxConnection:
running_sandboxes = client.InstancesApi(api_client).instances_get()
return [
- RunningSandboxes(
+ RunningSandbox(
sandbox_id=s.instance_id,
template_id=s.env_id,
+ alias=s.alias,
metadata=s.metadata or {},
)
for s in running_sandboxes
diff --git a/spec/openapi.yml b/spec/openapi.yml
index b721c3e5c..dc4d72e1e 100644
--- a/spec/openapi.yml
+++ b/spec/openapi.yml
@@ -140,6 +140,9 @@ components:
instanceID:
type: string
description: Identifier of the instance
+ alias:
+ type: string
+ description: Alias of the environment
clientID:
type: string
description: Identifier of the client
@@ -167,6 +170,9 @@ components:
envID:
type: string
description: Identifier of the environment from which is the instance created
+ alias:
+ type: string
+ description: Alias of the environment
instanceID:
type: string
description: Identifier of the instance