E2B
Open-source, secure environment with real-world tools for enterprise-grade agents.
File Explorer
- config.json
- README.md
- action.yml
- bug_report.yaml
- config.yml
- feature_request.md
- build_release_itinerary.cjs
- is_release.sh
- is_release_for_package.sh
- cli_tests.yml
- codegen_image_cache.yml
- generated_files.yml
- js_sdk_tests.yml
- lint.yml
- pkg_artifacts.yml
- publish_candidates.yml
- publish_packages.yml
- python_sdk_tests.yml
- release-candidate.yml
- release.yml
- sdk_tests.yml
- templates.yml
- typecheck.yml
- extensions.json
- launch.json
- settings.json
- configure.ts
- index.ts
- info.ts
- login.ts
- logout.ts
- connect.ts
- create.ts
- exec.ts
- exec_helpers.ts
- index.ts
- info.ts
- kill.ts
- list.ts
- logs.ts
- metrics.ts
- pause.ts
- resume.ts
- snapshot.ts
- utils.ts
- file-utils.ts
- handlebars.ts
- index.ts
- template-generator.ts
- types.ts
- build.ts
- create.ts
- delete.ts
- dockerfile.ts
- index.ts
- init.ts
- list.ts
- migrate.ts
- publish.ts
- index.ts
- index.ts
- constants.ts
- python-build-async.hbs
- python-build-sync.hbs
- python-template.hbs
- readme.hbs
- typescript-build.hbs
- typescript-template.hbs
- commands2md.ts
- confirm.ts
- env.ts
- errors.ts
- filesystem.ts
- format.ts
- openBrowser.ts
- signal.ts
- table.ts
- templateName.ts
- templatePrompt.ts
- templateSort.ts
- token-refresh.ts
- urls.ts
- wait.ts
- api.ts
- index.ts
- options.ts
- terminal.ts
- user.ts
- cool-doge.gif
- .dockerignore
- .gitignore
- Dockerfile
- main.mjs
- package.json
- backend_integration.test.ts
- create_lifecycle.test.ts
- exec_close_stdin.test.ts
- exec_helpers.test.ts
- exec_pipe.test.ts
- exec_stdin_flag.test.ts
- list.test.ts
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- build_dev.py
- build_prod.py
- template.py
- build_dev.py
- build_prod.py
- template.py
- build.dev.ts
- build.prod.ts
- template.ts
- e2b.Dockerfile
- e2b.toml
- create.test.ts
- delete.test.ts
- init.test.ts
- migrate.test.ts
- publish.test.ts
- env.test.ts
- errors.test.ts
- table.test.ts
- attribution.test.ts
- setup.ts
- user_config_migration.test.ts
- user_config_permissions.test.ts
- .envrc
- .gitignore
- .prettierignore
- CHANGELOG.md
- LICENSE
- package.json
- README.md
- tsconfig.json
- tsdown.config.ts
- vitest.config.ts
- http2.ts
- index.ts
- inflight.ts
- metadata.ts
- schema.gen.ts
- filesystem_connect.ts
- filesystem_pb.ts
- process_connect.ts
- process_pb.ts
- api.ts
- http2.ts
- rpc.ts
- schema.gen.ts
- versions.ts
- commandHandle.ts
- index.ts
- pty.ts
- index.ts
- watchHandle.ts
- index.ts
- utils.ts
- iam.ts
- index.ts
- mcp.d.ts
- network.ts
- sandboxApi.ts
- signature.ts
- buildApi.ts
- callable.ts
- consts.ts
- dockerfileParser.ts
- index.ts
- logger.ts
- readycmd.ts
- types.ts
- utils.ts
- client.ts
- index.ts
- schema.gen.ts
- types.ts
- client.ts
- connectionConfig.ts
- errors.ts
- index.ts
- is.ts
- logs.ts
- paginator.ts
- secret.ts
- undici.ts
- utils.ts
- handleApiError.test.ts
- http2.test.ts
- inflight.test.ts
- info.test.ts
- kill.test.ts
- list.test.ts
- snapshot.test.ts
- validateApiKey.test.ts
- edgeCompat.test.ts
- handleEnvdApiError.test.ts
- handleRpcError.test.ts
- http2.test.ts
- run.test.tsx
- vitest.config.mts
- run.test.ts
- setup.mts
- vitest.config.mts
- worker.mjs
- wrangler.jsonc
- commandHandle.test.ts
- connect.test.ts
- envVars.test.ts
- kill.test.ts
- list.test.ts
- run.test.ts
- sandboxKilledDuringRun.test.ts
- sendStdin.test.ts
- contentEncoding.test.ts
- entryInfo.test.ts
- exists.test.ts
- info.test.ts
- list.test.ts
- makeDir.test.ts
- metadata.test.ts
- read.test.ts
- remove.test.ts
- rename.test.ts
- signing.test.ts
- watch.test.ts
- watchHandle.test.ts
- write.test.ts
- add.test.ts
- branches.test.ts
- clone.test.ts
- commit.test.ts
- config.test.ts
- dangerouslyAuthenticate.test.ts
- helpers.ts
- init.test.ts
- remote.test.ts
- reset.test.ts
- restore.test.ts
- status.test.ts
- sync.test.ts
- validation.test.ts
- kill.test.ts
- ptyConnect.test.ts
- ptyCreate.test.ts
- resize.test.ts
- sendInput.test.ts
- abortSignal.test.ts
- configPropagation.test.ts
- connect.test.ts
- create.test.ts
- egressProxy.test.ts
- fork.test.ts
- host.test.ts
- iam.test.ts
- internetAccess.test.ts
- kill.test.ts
- lifecyclePayload.test.ts
- lifecycleRequest.test.ts
- metrics.test.ts
- network.test.ts
- networkTransform.test.ts
- rpcHeaders.test.ts
- secure.test.ts
- snapshot-api.test.ts
- snapshot.test.ts
- timeout.test.ts
- urls.test.ts
- secret.test.ts
- fromDockerfile.test.ts
- makeSymlink.test.ts
- runCmd.test.ts
- toDockerfile.test.ts
- getAllFilesInPath.test.ts
- getCallerDirectory.test.ts
- normalizeBuildArguments.test.ts
- readycmd.test.ts
- spoolTarArchive.test.ts
- validateRelativePath.test.ts
- abortSignal.test.ts
- backgroundBuild.test.ts
- boundOpts.test.ts
- build.test.ts
- exists.test.ts
- stacktrace.test.ts
- tags.test.ts
- uploadFile.test.ts
- file.test.ts
- mockVolumeContent.ts
- volume.test.ts
- client.test.ts
- cmdHelper.ts
- connectionConfig.browser.test.ts
- connectionConfig.test.ts
- foreignPlatformObjects.ts
- globalFetchFallback.setup.ts
- is.test.ts
- logs.test.ts
- paginator.test.ts
- runtime.test.ts
- setup.ts
- stripAnsi.test.ts
- template.ts
- undici.test.ts
- utils.test.ts
- .gitignore
- .prettierignore
- CHANGELOG.md
- example.mts
- LICENSE
- package.json
- README.md
- tsconfig.json
- tsdown.config.ts
- vitest.config.mts
- __init__.py
- delete_sandboxes_sandbox_id.py
- get_sandboxes.py
- get_sandboxes_metrics.py
- get_sandboxes_sandbox_id.py
- get_sandboxes_sandbox_id_logs.py
- get_sandboxes_sandbox_id_metrics.py
- get_v2_sandboxes.py
- get_v_2_sandboxes_sandbox_id_logs.py
- post_sandboxes.py
- post_sandboxes_sandbox_id_connect.py
- post_sandboxes_sandbox_id_fork.py
- post_sandboxes_sandbox_id_pause.py
- post_sandboxes_sandbox_id_refreshes.py
- post_sandboxes_sandbox_id_resume.py
- post_sandboxes_sandbox_id_snapshots.py
- post_sandboxes_sandbox_id_timeout.py
- put_sandboxes_sandbox_id_network.py
- __init__.py
- delete_secrets_secret_id.py
- get_secrets.py
- get_secrets_secret_id.py
- post_secrets.py
- post_secrets_secret_id.py
- __init__.py
- get_snapshots.py
- __init__.py
- delete_templates_tags.py
- get_templates_template_id_tags.py
- post_templates_tags.py
- __init__.py
- delete_templates_template_id.py
- get_templates.py
- get_templates_aliases_alias.py
- get_templates_template_id.py
- get_templates_template_id_builds_build_id_logs.py
- get_templates_template_id_builds_build_id_status.py
- get_templates_template_id_files_hash.py
- get_v2_templates.py
- patch_templates_template_id.py
- patch_v_2_templates_template_id.py
- post_templates.py
- post_templates_template_id.py
- post_templates_template_id_builds_build_id.py
- post_v2_templates.py
- post_v3_templates.py
- post_v_2_templates_template_id_builds_build_id.py
- __init__.py
- delete_volumes_volume_id.py
- get_volumes.py
- get_volumes_volume_id.py
- post_volumes.py
- __init__.py
- __init__.py
- admin_build_cancel_result.py
- admin_sandbox_kill_result.py
- admin_team_running_sandbox_counts.py
- assign_template_tags_request.py
- assigned_template_tags.py
- aws_registry.py
- aws_registry_type.py
- build_log_entry.py
- build_status_reason.py
- connect_sandbox.py
- created_access_token.py
- created_team_api_key.py
- delete_template_tags_request.py
- disk_metrics.py
- error.py
- gcp_registry.py
- gcp_registry_type.py
- general_registry.py
- general_registry_type.py
- identifier_masking_details.py
- listed_sandbox.py
- log_level.py
- logs_direction.py
- logs_source.py
- machine_info.py
- max_team_metric.py
- mcp_type_0.py
- new_access_token.py
- new_sandbox.py
- new_secret.py
- new_team_api_key.py
- new_volume.py
- node.py
- node_detail.py
- node_metrics.py
- node_status.py
- node_status_change.py
- order_direction.py
- resumed_sandbox.py
- sandbox.py
- sandbox_auto_resume_config.py
- sandbox_detail.py
- sandbox_egress_proxy_config_type_0.py
- sandbox_fork_request.py
- sandbox_fork_result.py
- sandbox_iam.py
- sandbox_iam_token.py
- sandbox_iam_tokens.py
- sandbox_lifecycle.py
- sandbox_log.py
- sandbox_log_entry.py
- sandbox_log_entry_fields.py
- sandbox_logs.py
- sandbox_logs_v2_response.py
- sandbox_metric.py
- sandbox_network_config.py
- sandbox_network_config_rules.py
- sandbox_network_rule.py
- sandbox_network_transform.py
- sandbox_network_transform_headers.py
- sandbox_network_update_config.py
- sandbox_network_update_config_rules.py
- sandbox_on_timeout.py
- sandbox_pause_request.py
- sandbox_refresh_request.py
- sandbox_snapshot_request.py
- sandbox_state.py
- sandbox_timeout_request.py
- sandbox_volume_mount.py
- sandboxes_with_metrics.py
- secret.py
- secret_metadata.py
- secret_update.py
- snapshot_info.py
- team.py
- team_api_key.py
- team_metric.py
- team_user.py
- template.py
- template_alias_response.py
- template_build.py
- template_build_file_upload.py
- template_build_info.py
- template_build_logs_response.py
- template_build_request.py
- template_build_request_v2.py
- template_build_request_v3.py
- template_build_start_v2.py
- template_build_status.py
- template_legacy.py
- template_request_response_v3.py
- template_step.py
- template_tag.py
- template_update_request.py
- template_update_response.py
- template_with_builds.py
- update_team_api_key.py
- volume.py
- volume_and_token.py
- volume_token.py
- __init__.py
- client.py
- errors.py
- py.typed
- types.py
- __init__.py
- __init__.py
- __init__.py
- metadata.py
- __init__.py
- __init__.py
- __init__.py
- filesystem_connect.py
- filesystem_pb.py
- __init__.py
- process_connect.py
- process_pb.py
- __init__.py
- api.py
- client_shared.py
- interceptors.py
- rpc.py
- utils.py
- versions.py
- __init__.py
- args.py
- auth.py
- config.py
- parse.py
- types.py
- command_handle.py
- main.py
- filesystem.py
- watch_handle.py
- iam.py
- main.py
- mcp.py
- network.py
- sandbox_api.py
- signature.py
- utils.py
- command.py
- command_handle.py
- pty.py
- filesystem.py
- watch_handle.py
- git.py
- main.py
- paginator.py
- sandbox_api.py
- utils.py
- command.py
- command_handle.py
- pty.py
- filesystem.py
- watch_handle.py
- git.py
- main.py
- paginator.py
- sandbox_api.py
- __init__.py
- base.py
- secret_async.py
- secret_sync.py
- types.py
- consts.py
- dockerfile_parser.py
- logger.py
- main.py
- readycmd.py
- types.py
- utils.py
- build_api.py
- main.py
- build_api.py
- main.py
- __init__.py
- delete_volumecontent_volume_id_path.py
- get_volumecontent_volume_id_dir.py
- get_volumecontent_volume_id_file.py
- get_volumecontent_volume_id_path.py
- patch_volumecontent_volume_id_path.py
- post_volumecontent_volume_id_dir.py
- put_volumecontent_volume_id_file.py
- __init__.py
- __init__.py
- error.py
- patch_volumecontent_volume_id_path_body.py
- volume_entry_stat.py
- volume_entry_stat_type.py
- __init__.py
- client.py
- errors.py
- py.typed
- types.py
- __init__.py
- __init__.py
- connection_config.py
- types.py
- utils.py
- volume_async.py
- volume_sync.py
- __init__.py
- client.py
- connection_config.py
- exceptions.py
- io_utils.py
- paginator.py
- py.typed
- sandbox_domains.py
- fix-python-pb.sh
- test_sbx_info.py
- test_sbx_kill.py
- test_sbx_list.py
- test_sbx_snapshot.py
- test_cmd_connect.py
- test_cmd_kill.py
- test_cmd_list.py
- test_env_vars.py
- test_run.py
- test_sandbox_killed_during_run.py
- test_send_stdin.py
- test_content_encoding.py
- test_exists.py
- test_files_list.py
- test_info.py
- test_make_dir.py
- test_metadata.py
- test_read.py
- test_remove.py
- test_rename.py
- test_secured.py
- test_watch.py
- test_write.py
- test_pty_connect.py
- test_pty_create.py
- test_pty_kill.py
- test_resize.py
- test_send_input.py
- test_config_propagation.py
- test_connect.py
- test_create.py
- test_fork.py
- test_host.py
- test_internet_access.py
- test_kill.py
- test_metrics.py
- test_network.py
- test_secure.py
- test_snapshot.py
- test_snapshot_api.py
- test_snapshot_filesystem_only.py
- test_timeout.py
- test_secret.py
- test_from_dockerfile.py
- test_make_symlink.py
- test_run_cmd.py
- test_to_dockerfile.py
- conftest.py
- test_background_build.py
- test_bound_api_params.py
- test_build.py
- test_exists.py
- test_stacktrace.py
- test_tags.py
- test_upload_file.py
- test_file.py
- test_volume.py
- test_volume_content.py
- test_encode_path_param.py
- conftest.py
- test_add.py
- test_args.py
- test_branches.py
- test_clone.py
- test_commit.py
- test_config.py
- test_dangerously_authenticate.py
- test_init.py
- test_parity.py
- test_remote.py
- test_reset.py
- test_restore.py
- test_status.py
- test_sync.py
- test_egress_proxy.py
- test_lifecycle_request.py
- test_network_transform.py
- test_get_all_files_in_path.py
- test_get_caller_directory.py
- test_normalize_build_arguments.py
- test_strip_ansi_escape_codes.py
- test_tar_file_stream.py
- test_validate_relative_path.py
- test_readycmd.py
- test_sbx_info.py
- test_sbx_kill.py
- test_sbx_list.py
- test_sbx_snapshot.py
- test_cmd_connect.py
- test_cmd_kill.py
- test_cmd_list.py
- test_env_vars.py
- test_run.py
- test_sandbox_killed_during_run.py
- test_send_stdin.py
- test_content_encoding.py
- test_exists.py
- test_files_list.py
- test_info.py
- test_make_dir.py
- test_metadata.py
- test_read.py
- test_remove.py
- test_rename.py
- test_secured.py
- test_watch.py
- test_write.py
- test_pty.py
- test_pty_connect.py
- test_pty_kill.py
- test_resize.py
- test_send_input.py
- test_config_propagation.py
- test_connect.py
- test_create.py
- test_fork.py
- test_host.py
- test_internet_access.py
- test_kill.py
- test_metrics.py
- test_network.py
- test_secure.py
- test_snapshot.py
- test_snapshot_api.py
- test_snapshot_filesystem_only.py
- test_sync_client_lifecycle.py
- test_timeout.py
- test_secret.py
- test_from_dockerfile.py
- test_make_symlink.py
- test_run_cmd.py
- test_to_dockerfile.py
- conftest.py
- test_background_build.py
- test_bound_api_params.py
- test_build.py
- test_exists.py
- test_stacktrace.py
- test_tags.py
- test_upload_file.py
- test_file.py
- test_volume.py
- test_volume_content.py
- conftest.py
- envd_frame_server.py
- mock_volume_content.py
- test_api_client_transport.py
- test_client.py
- test_command_handle.py
- test_connection_config.py
- test_env_var_parsing.py
- test_envd_api_exception.py
- test_envd_client_transport.py
- test_envd_codec.py
- test_envd_interceptors.py
- test_envd_plain_http_errors.py
- test_envd_retry_transport.py
- test_envd_rpc_exception.py
- test_envd_stream_request_timeout.py
- test_envd_stream_reset.py
- test_envd_utils.py
- test_file_stream_reader.py
- test_filesystem_models.py
- test_io_utils.py
- test_logging_option.py
- test_paginator.py
- test_retry_stream_buffering.py
- test_sandbox_urls.py
- test_shared_transport_pool.py
- test_validate_api_key.py
- test_volume_client.py
- test_volume_connection_config.py
- test_watch_handle.py
- transport_caches.py
- .gitignore
- CHANGELOG.md
- example.py
- LICENSE
- Makefile
- package.json
- pyproject.toml
- pytest.ini
- README.md
- uv.lock
- e2b-sdk-dark.png
- e2b-sdk-light.png
- logo-black.png
- logo-circle.png
- logo-white.png
- preview.png
- fetch-spec.sh
- SKILL.md
- filesystem.proto
- process.proto
- buf-js.gen.yaml
- buf-python.gen.yaml
- envd.yaml
- belt-ref
- infra-ref
- mcp-server.json
- openapi-volumecontent.yml
- openapi.yml
- README.md
- e2b.Dockerfile
- e2b.Dockerfile
- .editorconfig
- .gitattributes
- .gitignore
- .npmrc
- .oxlintrc.json
- .prettierignore
- .prettierrc
- .tool-versions
- .vale.ini
- AGENTS.md
- CLAUDE.md
- codegen.Dockerfile
- CODEOWNERS
- CONTRIBUTING.md
- copy.bara.sky
- copybara.Dockerfile
- DEV.md
- LICENSE
- Makefile
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- redocly.yaml
- TASTE.md
# Installation Guide
nodeSetup Steps
npm i e2b
Install the E2B SDK for JavaScript/TypeScript.
pip install e2b
Install the E2B SDK for Python.
export E2B_API_KEY=e2b_***
Set the E2B API key as an environment variable.
Key Commands
npm i e2b
Install the E2B SDK package in a JavaScript/TypeScript project.
pip install e2b
Install the E2B SDK package in a Python project.
npm i @e2b/code-interpreter
Install the JavaScript SDK for code interpreter features.
pip install e2b-code-interpreter
Install the Python SDK for code interpreter features.
You need to get an API key from the E2B dashboard and set it as the E2B_API_KEY environment variable.
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Link
Example
Release Timeline
Actively Maintained- 2026-09-10 [email protected]
- 2026-09-10 @e2b/[email protected]
- 2026-09-09 [email protected]
- 2026-09-09 [email protected]
- 2026-09-09 @e2b/[email protected]
- 2026-09-09 @e2b/[email protected]
- 2026-09-09 @e2b/[email protected]
- 2026-09-09 @e2b/[email protected]
- 2026-09-09 @e2b/[email protected]
- 2026-09-09 @e2b/[email protected]
Command Glossary
Commands referenced in this DOCs, explained below.
npm
View Details ▼
npm
JavaScript and Node.js package manager.
Manage Node.js projects and their module dependencies.
Some subcommands such as `install`, `run`, etc. have their own usage documentation.
npm init {{[-y|--yes]}}
Create a `package.json` file with default values (omit `--yes` to do it interactively):
npm {{[i|install]}}
Download all the packages listed as dependencies in `package.json`:
npm {{[i|install]}} {{package_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
pip install
View Details ▼
pip install
Install Python packages.
pip install {{package1 package2 ...}}
Install one or more packages:
pip install {{package1 package2 ...}} {{[-U|--upgrade]}}
Upgrade all specified packages to the latest version, installing any that are not already present:
pip install {{package}}=={{version}}
Install a specific version of a package:
// repository documentation
Was this content helpful?
(0 ratings)